001    /*
002     * Copyright (c) 2009 The openGion Project.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *     http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013     * either express or implied. See the License for the specific language
014     * governing permissions and limitations under the License.
015     */
016    package org.opengion.fukurou.util;
017    
018    /**
019     * HybsEntry.java 縺ｯ縲∝?驛ｨ縺ｫ final 螳夂ｾｩ縺輔ｌ縺滓枚蟄怜?縺ｮ縲〔ey 縺ｨ value 繧呈戟縺､縲∝?繧ｯ繝ｩ繧ｹ縺ｧ縺吶?
020     *
021     * 蜈ｨ螟画焚縺ｯ縲｝ublic final 螳｣險?＆繧後※縺翫ｊ縲∝､夜Κ繧医ｊ蜿門ｾ励〒縺阪∪縺吶′縲∬ｨｭ螳壹〒縺阪∪縺帙ｓ縲?
022     * 縺薙?繧ｯ繝ｩ繧ｹ縺ｯ縲√さ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ縺ｧ險ｭ螳壹＆繧後◆繧ｭ繝ｼ縺ｨ險ｭ螳壼?繧貞､峨∴繧倶ｺ九′蜃ｺ譚･縺ｾ縺帙ｓ縲?
023     * 繧医▲縺ｦ縲√ョ繝輔か繝ｫ繝医さ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ繧呈戟縺溘↑縺?◆繧√?java.io.Serializable 繧､繝ｳ繧ｿ繝ｼ繝輔ぉ繝ｼ繧ｹ縺ｯ
024     * 謖√■縺ｾ縺帙ｓ縲ゅ∪縺溘?蜀?Κ縺ｮ蛟､繧貞､画峩縺ｧ縺阪↑縺?ぜ縲…lone() 繧偵☆繧句ｿ?ｦ√′縺ｪ縺?◆繧√?
025     * java.lang.Cloneable 繧､繝ｳ繧ｿ繝ｼ繝輔ぉ繝ｼ繧ｹ繧ょｮ溯｣?＠縺ｦ縺?∪縺帙ｓ縲?
026     * HybsEntry 繧ｪ繝悶ず繧ｧ繧ｯ繝医?蜷御ｸ??繧堤｢ｺ菫昴☆繧九↓縺ｯ縲‘quals( Object ) 縺ｨ縲”ashCode() 繝｡繧ｽ繝?ラ繧?
027     * 繧ｪ繝ｼ繝舌?繝ｩ繧､繝峨＠縺ｦ縺翫￥蠢?ｦ√′縺ゅｊ縺ｾ縺吶?蜷御ｸ??縺ｮ譚｡莉ｶ縺ｯ縲〔ey 縺ｨ value 縺後?縺ｨ繧ゅ↓
028     * String.equals 縺ｮ髢｢菫ゅｒ謖√※縺ｰ縲∵?遶九☆繧九％縺ｨ縺ｨ縺励∪縺吶?
029     *
030     * @version  4.0
031     * @author       Kazuhiko Hasegawa
032     * @since    JDK5.0,
033     */
034    public final class HybsEntry implements Comparable<HybsEntry> {   // 4.3.3.6 (2008/11/15) Generics隴ｦ蜻雁ｯｾ蠢?
035            /** 蜀?Κ縺ｮ繧ｭ繝ｼ諠??        */
036            private final String key ;
037            /** 蜀?Κ縺ｮ繝舌Μ繝･繝ｼ諠??     */
038            private final String value ;
039            /** 蜀?Κ縺ｮ繧ｳ繝｡繝ｳ繝域ュ蝣ｱ    */
040            private final String comment ;  // 4.0.0 (2005/01/31) 霑ｽ蜉?
041    
042            // 4.0.0 (2005/01/31) private 蛹?
043            private final int hCode ;
044            //      private static final ValueComparator valueComp = new ValueComparator();
045    
046            /**
047             * 繧ｳ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ
048             * 蜀?Κ螟画焚縺ｸ縺ｮ蛟､縺ｮ險ｭ螳壹?縲√％縺ｮ繧ｳ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ繝ｼ縺ｧ陦後ｏ繧後∪縺吶?
049             * key 縺ｸ縺ｮ null 繧ｻ繝?ヨ縺ｯ隱阪ａ繧峨ｌ縺ｾ縺帙ｓ縲Ｗalue 縺ｸ縺ｯ縲√そ繝?ヨ縺ｧ縺阪∪縺吶?
050             * 繧ｳ繝｡繝ｳ繝医?縲√ぞ繝ｭ譁?ｭ怜?("") 縺ｧ縲∝?譛溷喧縺輔ｌ縺ｾ縺吶?
051             *
052             * @param key   繧ｭ繝ｼ
053             * @param value 蛟､
054             * @throws IllegalArgumentException key 縺ｫ null 縺後そ繝?ヨ縺輔ｌ縺溷?蜷?
055             */
056            public HybsEntry( final String key,final String value ) {
057                    this( key,value,"" );
058            }
059    
060            /**
061             * 繧ｳ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ
062             * 蜀?Κ螟画焚縺ｸ縺ｮ蛟､縺ｮ險ｭ螳壹?縲√％縺ｮ繧ｳ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ繝ｼ縺ｧ陦後ｏ繧後∪縺吶?
063             * key 縺ｸ縺ｮ null 繧ｻ繝?ヨ縺ｯ隱阪ａ繧峨ｌ縺ｾ縺帙ｓ縲Ｗalue 縺ｸ縺ｯ縲√そ繝?ヨ縺ｧ縺阪∪縺吶?
064             *
065             * @param key   繧ｭ繝ｼ
066             * @param value 蛟､
067             * @param comment 繧ｳ繝｡繝ｳ繝?
068             * @throws IllegalArgumentException key 縺ｫ null 縺後そ繝?ヨ縺輔ｌ縺溷?蜷?
069             */
070            public HybsEntry( final String key,final String value,final String comment ) {
071                    if( key == null ) {
072                            String errMsg = "key 縺ｸ縺ｮ null 繧ｻ繝?ヨ縺ｯ隱阪ａ繧峨ｌ縺ｾ縺帙ｓ縲? ;
073                            throw new IllegalArgumentException( errMsg );
074                    }
075    
076                    this.key        = key;
077                    this.value      = value;
078                    this.comment = comment;
079                    hCode           = ( key + ',' + value + '.' + comment ).hashCode();
080            }
081    
082            /**
083             * 繧ｨ繝ｳ繝医Μ縺ｫ蟇ｾ蠢懊☆繧九く繝ｼ繧定ｿ斐＠縺ｾ縺吶?
084             *
085             * @return      繧ｨ繝ｳ繝医Μ縺ｫ蟇ｾ蠢懊☆繧九く繝ｼ
086             */
087            public String getKey() { return key; }
088    
089            /**
090             * 繧ｨ繝ｳ繝医Μ縺ｫ蟇ｾ蠢懊☆繧句?繧定ｿ斐＠縺ｾ縺吶?
091             *
092             * @return      繧ｨ繝ｳ繝医Μ縺ｫ蟇ｾ蠢懊☆繧句?
093             */
094            public String getValue() { return value; }
095    
096            /**
097             * 繧ｨ繝ｳ繝医Μ縺ｫ蟇ｾ蠢懊☆繧九さ繝｡繝ｳ繝医ｒ霑斐＠縺ｾ縺吶?
098             *
099             * @return 繧ｨ繝ｳ繝医Μ縺ｫ蟇ｾ蠢懊☆繧九さ繝｡繝ｳ繝?
100             */
101            public String getComment() { return comment; }
102    
103            /**
104             * HybsEntry 縺ｮ險ｭ螳壹＆繧後※縺?ｋ蛟､繧貞､画峩縺励∪縺吶?
105             * 縺薙ｌ縺ｯ縲∬ｨｭ螳壼?繧貞､画峩縺励◆譁ｰ縺励＞ HybsEntry 繧剃ｽ懈?縺励※霑斐＠縺ｾ縺吶?
106             * 縺ｪ縺翫?value 縺後?蜀?Κ縺ｮ蛟､縺ｨ遲峨＠縺?凾(equals 縺梧?遶九☆繧区凾)閾ｪ蛻??霄ｫ繧定ｿ斐＠縺ｾ縺吶?
107             *
108             * @param newValue 譁ｰ縺励＞蛟､
109             *
110             * @return 繧ｨ繝ｳ繝医Μ繝ｼ HybsEntry
111             */
112            public HybsEntry getValue( final String newValue ) {
113                    if(  ( newValue == null && value == null ) ||
114                             ( newValue != null && newValue.equals( value ) ) ) {
115                                    return this;
116                    }
117                    else {
118                            return new HybsEntry( key,newValue,comment );
119                    }
120            }
121    
122            /**
123             * 閾ｪ辟ｶ豈碑ｼ?Γ繧ｽ繝?ラ
124             * 繧､繝ｳ繧ｿ繝輔ぉ繝ｼ繧ｹ Comparable 縺ｮ 螳溯｣?〒縺吶?
125             * HybsEntry縺ｮ鬆?ｺ上?縲〔ey 縺ｮ鬆?ｺ上〒縺ゅｉ繧上＆繧後∪縺吶?
126             * 蜷御ｸ?ey縺ｮ蝣ｴ蜷医??計alue 縺ｮ鬆?分縺ｫ縺ｪ繧翫∪縺吶?
127             *
128             * @param   other 豈碑ｼ?ｯｾ雎｡縺ｮObject
129             *
130             * @return  縺薙?繧ｪ繝悶ず繧ｧ繧ｯ繝医′謖?ｮ壹＆繧後◆繧ｪ繝悶ず繧ｧ繧ｯ繝医ｈ繧雁ｰ上＆縺??蜷医?雋??謨ｴ謨ｰ縲∫ｭ峨＠縺??蜷医?繧ｼ繝ｭ縲∝､ｧ縺阪＞蝣ｴ蜷医?豁｣縺ｮ謨ｴ謨ｰ
131             * @throws ClassCastException 謖?ｮ壹＆繧後◆繧ｪ繝悶ず繧ｧ繧ｯ繝医′繧ｭ繝｣繧ｹ繝医〒縺阪↑縺??蜷医?
132             */
133    //      public int compareTo( final Object object ) {
134    //              HybsEntry other = (HybsEntry)object;                    // 繧ｭ繝｣繧ｹ繝亥､ｱ謨励〒縲，lassCastException
135            public int compareTo( final HybsEntry other ) {         // 4.3.3.6 (2008/11/15) Generics隴ｦ蜻雁ｯｾ蠢?
136                    int comp = key.compareTo( other.key );
137    
138                    if( comp == 0 ) {
139                            if( value != null ) { comp = value.compareTo( other.value ); }
140                            else {                            comp = ( other.value == null ) ? 0 : -1 ; }
141    
142                            if( comp == 0 ) {
143                                    comp = comment.compareTo( other.comment );
144                            }
145                    }
146                    return comp ;
147            }
148    
149            /**
150             * 縺薙?繧ｪ繝悶ず繧ｧ繧ｯ繝医→莉悶?繧ｪ繝悶ず繧ｧ繧ｯ繝医′遲峨＠縺?°縺ｩ縺?°繧堤､ｺ縺励∪縺吶?
151             * 繧､繝ｳ繧ｿ繝輔ぉ繝ｼ繧ｹ Comparable 縺ｮ 螳溯｣?↓髢｢騾｣縺励※縲∝?螳夂ｾｩ縺励※縺?∪縺吶?
152             * HybsEntry縺ｯ縲〔ey 縺檎ｭ峨＠縺上?縺九▽ value縺悟酔荳??蝣ｴ蜷医↓縲?
153             * 遲峨＠縺?→蛻､譁ｭ縺輔ｌ縺ｾ縺吶?
154             *
155             * @param   object 豈碑ｼ?ｯｾ雎｡縺ｮ蜿ら?繧ｪ繝悶ず繧ｧ繧ｯ繝?
156             *
157             * @return      蠑墓焚縺ｫ謖?ｮ壹＆繧後◆繧ｪ繝悶ず繧ｧ繧ｯ繝医→縺薙?繧ｪ繝悶ず繧ｧ繧ｯ繝医′遲峨＠縺??蜷医? true縲√◎縺?〒縺ｪ縺??蜷医? false
158             */
159            @Override
160            public boolean equals( final Object object ) {
161                    if( object instanceof HybsEntry ) {
162                            HybsEntry other = (HybsEntry)object;
163                            return  ( key.equals( other.key ) )  &&
164                                            ( value != null && value.equals( other.value ) );
165                    }
166                    return false ;
167            }
168    
169            /**
170             * 繧ｪ繝悶ず繧ｧ繧ｯ繝医?繝上ャ繧ｷ繝･繧ｳ繝ｼ繝牙?繧定ｿ斐＠縺ｾ縺吶?
171             * 縺薙?繝｡繧ｽ繝?ラ縺ｯ縲）ava.util.Hashtable 縺ｫ繧医▲縺ｦ謠蝉ｾ帙＆繧後ｋ繧医≧縺ｪ
172             * 繝上ャ繧ｷ繝･繝??繝悶Ν縺ｧ菴ｿ逕ｨ縺吶ｋ縺溘ａ縺ｫ逕ｨ諢上＆繧後※縺?∪縺吶?
173             * equals( Object ) 繝｡繧ｽ繝?ラ繧偵が繝ｼ繝舌?繝ｩ繧､繝医＠縺溷?蜷医?縲”ashCode() 繝｡繧ｽ繝?ラ繧?
174             * 蠢?★ 險倩ｿｰ縺吶ｋ蠢?ｦ√′縺ゅｊ縺ｾ縺吶?
175             * 縺薙％縺ｧ縺ｯ縲〔ey 縺ｨ value 縺ｮ蜷域?縺励◆譁?ｭ怜?縺ｮ繝上ャ繧ｷ繝･繧ｳ繝ｼ繝牙?繧定ｿ斐＠縺ｾ縺吶?
176             *
177             * @return  縺薙?繧ｪ繝悶ず繧ｧ繧ｯ繝医?繝上ャ繧ｷ繝･繧ｳ繝ｼ繝牙?
178             *
179             */
180            @Override
181            public int hashCode() {
182                    return hCode ;
183            }
184    
185            /**
186             * 繧ｪ繝悶ず繧ｧ繧ｯ繝医?隴伜挨蟄舌→縺励※?瑚ｩｳ邏ｰ縺ｪ繝ｦ繝ｼ繧ｶ繝ｼ諠??繧定ｿ斐＠縺ｾ縺吶?
187             *
188             * @return  隧ｳ邏ｰ縺ｪ繝ｦ繝ｼ繧ｶ繝ｼ諠??
189             */
190            @Override
191            public String toString() {
192                    return "key=[" + key + "],value=[" + value + "],comment=[" + comment + "]" ;
193            }
194    
195            /**
196             * 險ｭ螳壼?縺ｮ鬆?ｺ上ｒ陦ｨ縺?Comparator 繧定ｿ斐＠縺ｾ縺吶?
197             * HybsEntry繧ｯ繝ｩ繧ｹ閾ｪ霄ｫ縺ｯ縲〔ey 縺ｮ鬆?分縺ｧ閾ｪ辟ｶ鬆?ｺ丈ｻ倥￠繧定｡後≧縲，omparable 繧､繝ｳ繧ｿ繝ｼ繝輔ぉ繝ｼ繧ｹ繧?
198             * 螳溯｣?＠縺ｦ縺?∪縺吶?縺励°縺励?險ｭ螳壼?縺ｧ繧ｽ繝ｼ繝医☆繧句?蜷医?縲√％縺ｮ
199             * Comparator 繧､繝ｳ繧ｿ繝ｼ繝輔ぉ繝ｼ繧ｹ繧貞ｮ溯｣?＠縺溷?驛ｨ繧ｯ繝ｩ繧ｹ繧剃ｽｿ逕ｨ縺吶ｋ縺薙→縺ｧ縲?
200             * 蟇ｾ蠢懷?譚･縺ｾ縺吶?
201             *
202             * @return  險ｭ螳壼?縺ｮ鬆?ｺ上ｒ陦ｨ縺?Comparator
203             */
204            //      public Comparator getValueComparator() {
205            //              return valueComp ;
206            //      }
207    
208            /**
209             * 繧ｪ繝悶ず繧ｧ繧ｯ繝医?隴伜挨蟄舌→縺励※?瑚ｩｳ邏ｰ縺ｪ繝ｦ繝ｼ繧ｶ繝ｼ諠??繧定ｿ斐＠縺ｾ縺吶?
210             *
211             * @return  隧ｳ邏ｰ縺ｪ繝ｦ繝ｼ繧ｶ繝ｼ諠??
212             */
213            //      private static class ValueComparator implements Comparator {
214            //              /**
215            //               * value 縺ｮ鬆?ｺ丈ｻ倥￠縺ｮ縺溘ａ縺ｫ 2 縺､縺ｮ蠑墓焚繧呈ｯ碑ｼ?＠縺ｾ縺吶?
216            //               * 譛??縺ｮ蠑墓焚縺?2 逡ｪ逶ｮ縺ｮ蠑墓焚繧医ｊ蟆上＆縺??蜷医?雋??謨ｴ謨ｰ縲∽ｸ｡譁ｹ縺檎ｭ峨＠縺??蜷医? 0縲?
217            //               * 譛??縺ｮ蠑墓焚縺?2 逡ｪ逶ｮ縺ｮ蠑墓焚繧医ｊ螟ｧ縺阪＞蝣ｴ蜷医?豁｣縺ｮ謨ｴ謨ｰ繧定ｿ斐＠縺ｾ縺吶?
218            //               *
219            //               * @param   o1 Object 豈碑ｼ?ｯｾ雎｡縺ｮ譛??縺ｮ繧ｪ繝悶ず繧ｧ繧ｯ繝?
220            //               * @param   o2 Objectb豈碑ｼ?ｯｾ雎｡縺ｮ 2 逡ｪ逶ｮ縺ｮ繧ｪ繝悶ず繧ｧ繧ｯ繝?
221            //               * @return  譛??縺ｮ蠑墓焚縺?2 逡ｪ逶ｮ縺ｮ蠑墓焚繧医ｊ蟆上＆縺??蜷医?雋??謨ｴ謨ｰ縲∽ｸ｡譁ｹ縺檎ｭ峨＠縺??蜷医? 0縲∵怙蛻昴?蠑墓焚縺?2 逡ｪ逶ｮ縺ｮ蠑墓焚繧医ｊ螟ｧ縺阪＞蝣ｴ蜷医?豁｣縺ｮ謨ｴ謨ｰ
222            //               * @throws  ClassCastException - 蠑墓焚縺ｮ蝙九′縺薙?繧ｳ繝ｳ繝代Ξ繝ｼ繧ｿ縺ｫ繧医ｋ豈碑ｼ?ｒ螯ｨ縺偵ｋ蝣ｴ蜷?
223            //               */
224            //              public int compare(Object o1, Object o2) {
225            //                      HybsEntry e1 = (HybsEntry)o1 ;          // 繧ｭ繝｣繧ｹ繝亥､ｱ謨励〒縲，lassCastException
226            //                      HybsEntry e2 = (HybsEntry)o2 ;          // 繧ｭ繝｣繧ｹ繝亥､ｱ謨励〒縲，lassCastException
227            //
228            //                      int comp = 0;
229            //                      if( e1 == null && e2 == null ) { comp = 0; }
230            //                      else if( e1 == null && e2 != null ) { comp = -1; }
231            //                      else if( e1 != null && e2 == null ) { comp = 1;  }
232            //                      else if( e1 != null && e2 != null ) {
233            //                              if( e1.value == null && e2.value == null ) { comp = 0; }
234            //                              else if( e1.value == null && e2.value != null ) { comp = -1; }
235            //                              else if( e1.value != null && e2.value == null ) { comp = 1; }
236            //                              else {
237            //                                      comp = e1.value.compareTo( e2.value );
238            //                              }
239            //                      }
240            //                      return comp ;
241            //              }
242            //      }
243    }