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    import java.util.Map ;
019    import java.util.LinkedHashMap ;
020    import java.util.Locale;
021    import java.util.Iterator;
022    
023    /**
024     * EnumType.java 縺ｯ縲∝?騾夂噪縺ｫ菴ｿ逕ｨ縺輔ｌ繧?譁?ｭ怜梛驕ｸ謚槭ヵ繧｣繝ｼ繝ｫ繝峨ｒ邁｡邏?喧縺吶ｋ繧ｯ繝ｩ繧ｹ縺ｧ縺吶?
025     * JDK5.0 繧医ｊ蟆主?縺輔ｌ縺?enum 縺ｫ鬘樔ｼｼ縺ｮ讖溯?繧呈署萓帙＠縺ｾ縺吶′縲∝?驛ｨ逧?↓繧医ｊ迚ｹ蛹悶＠縺?
026     * 讖溯?繧呈署萓帙＠縺ｾ縺吶?
027     * 蜈ｷ菴鍋噪縺ｫ縺ｯ縲√ョ繝舌ャ繧ｰ諠??縺ｮ邁｡譏灘?蜉帙ｄ縲∵枚蟄怜?蜈･蜉帶凾縺ｮ蛹?性髢｢菫ゅメ繧ｧ繝?け縲?
028     * 繝?ヵ繧ｩ繝ｫ繝亥?(蛻晄悄蛟､)縺ｮ逋ｻ骭ｲ縺ｪ縺ｩ縺ｧ縺吶?
029     * 蛻晄悄蛟､縺ｫ縺ｯ縲ヾtring,int,boolean 縺ｮ?薙ち繧､繝励′謖?ｮ壹〒縺阪∪縺吶?
030     *
031     * @version  4.0
032     * @author       Kazuhiko Hasegawa
033     * @since    JDK5.0,
034     */
035    public final class EnumType<T extends Comparable<T>> {      // 4.3.3.6 (2008/11/15) Generics隴ｦ蜻雁ｯｾ蠢?
036            /** 繧ｷ繧ｹ繝?Β萓晏ｭ倥?謾ｹ陦瑚ｨ伜捷繧偵そ繝?ヨ縺励∪縺吶?     */
037            private static final String CR = System.getProperty("line.separator");
038    
039            /** ?倥▽蛻??繧ｹ繝壹?繧ｹ縺ｧ縺吶?  */
040            private static final String SPACE = "    " ;
041    
042            private final Map<String,Types<T>> typemap = new LinkedHashMap<String,Types<T>>();
043    
044            private final String title  ;
045            private final T      defVal ;
046    
047            /**
048             * 繧ｿ繧､繝医Ν縺ｨ蛻晄悄蛟､繧呈欠螳壹＠縺ｦ讒狗ｯ峨☆繧?繧ｳ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ繝ｼ
049             * nval 繝｡繧ｽ繝?ラ繧剃ｽｿ逕ｨ縺吶ｋ蝣ｴ蜷医↓縲∝茜逕ｨ縺励∪縺吶?
050             *
051             * @param title 繧ｿ繧､繝医Ν
052             * @param val 蛻晄悄蛟､
053             */
054            public EnumType( final String title,final T val ) {
055                    this.title = title ;
056                    defVal = val ;
057            }
058    
059            /**
060             * 繧ｭ繝ｼ縺ｨ縺昴?隱ｬ譏?繝｡繝?そ繝ｼ繧ｸ)繧定ｿｽ蜉?＠縺ｾ縺吶?
061             * 蜀?Κ繧ｭ繝｣繝?す繝･(Map)縺ｫ霑ｽ蜉?＠縺ｾ縺吶?
062             * 騾壼ｸｸ縺ｮ繝｡繧ｽ繝?ラ蜷阪↑繧峨?put 縺?add 縺ｧ縺吶′縲〉eturn 縺ｫ
063             * 閾ｪ蛻??霄ｫ繧定ｨ倩ｿｰ縺ｧ縺阪ｋ縺溘ａ縲∝?譛溯ｨｭ螳?繧ｳ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ)?句?險ｭ螳壹ｒ
064             * 騾｣邯壹＠縺ｦ險倩ｿｰ縺吶ｋ縺薙→縺悟?譚･繧?append 繝｡繧ｽ繝?ラ縺ｫ縺｡縺ｪ繧薙〒蜻ｽ蜷阪＠縺ｦ縺?∪縺吶?
065             *
066             * @param key 繧ｭ繝ｼ
067             * @param msg 繝｡繝?そ繝ｼ繧ｸ
068             *
069             * @return      閾ｪ蛻??霄ｫ
070             */
071            public EnumType<T> append( final T key, final String msg ) {
072                    typemap.put( String.valueOf( key ).toUpperCase( Locale.JAPAN ),new Types<T>( key,msg ) );
073                    return this ;
074            }
075    
076            /**
077             * 譁?ｭ怜?逶ｸ蠖薙?險ｭ螳壼?繧医ｊ縲∝ｯｾ蠢懊☆繧?T 繧ｪ繝悶ず繧ｧ繧ｯ繝医ｒ霑斐＠縺ｾ縺吶?
078             * T 縺ｯ縲√う繝ｳ繧ｹ繧ｿ繝ｳ繧ｹ菴懈?譎ゅ↓縲］ew EnumType&lt;T&gt; 縺ｧ謖?ｮ壹☆繧九が繝悶ず繧ｧ繧ｯ繝医〒縺吶?
079             * 蠑墓焚縺ｮ譁?ｭ怜?縺ｯ縲?String.valueOf( T ) 縺ｧ蠕励ｉ繧後ｋ譁?ｭ怜?縺ｧ縺吶?
080             * 蠑墓焚縺後?null 縺九?髟ｷ縺輔ぞ繝ｭ縺ｮ譁?ｭ怜?縺ｮ蝣ｴ蜷医?縲√さ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ縺ｧ謖?ｮ壹＠縺?
081             * 蛻晄悄蛟､縺瑚ｿ斐＆繧後∪縺吶?
082             * T 縺ｫ Boolean 繧?Integer 繧呈欠螳壹＠縺ｦ縺?ｋ蝣ｴ蜷医?縲√い繝ｳ繝懊け繧ｷ繝ｳ繧ｰ讖溯?縺ｫ繧医ｊ縲?
083             * boolean 繧?int 縺ｫ閾ｪ蜍慕噪縺ｫ繧ｭ繝｣繧ｹ繝医＆繧後∪縺吶?
084             *
085             * @param       strKey 譁?ｭ怜?逶ｸ蠖薙?險ｭ螳壼?
086             *
087             * @return      strKey縺ｫ蟇ｾ蠢懊☆繧九が繝悶ず繧ｧ繧ｯ繝?
088             * @throws IllegalArgumentException 蠑墓焚縺勲ap縺ｫ蟄伜惠縺励↑縺九▲縺溷?蜷?null縺ｯOK)
089             */
090            public T nval( final String strKey ) {
091                    if( strKey != null && strKey.length() > 0 ) {
092                            String upKey = strKey.toUpperCase( Locale.JAPAN );
093                            if( typemap.containsKey( upKey ) ) {
094                                    Types<T> type = typemap.get( upKey );
095                                    return type.getKey();
096                            }
097                            else {
098                                    String errMsg = title + " 遽?峇險ｭ螳壹お繝ｩ繝ｼ"
099                                                            + CR + "蠑墓焚 [" + strKey + "] 縺ｯ縲∝?驛ｨ縺ｫ繝槭ャ繝励＆繧後※縺?∪縺帙ｓ縲?
100                                                            + CR + toString() ;
101                                    throw new IllegalArgumentException( errMsg );
102                            }
103                    }
104                    return defVal ;
105            }
106    
107            /**
108             * 蛻晄悄蛟､繧定ｿ斐＠縺ｾ縺吶?
109             * T 縺ｫ Boolean 繧?Integer 繧呈欠螳壹＠縺ｦ縺?ｋ蝣ｴ蜷医?縲√い繝ｳ繝懊け繧ｷ繝ｳ繧ｰ讖溯?縺ｫ繧医ｊ縲?
110             * boolean 繧?int 縺ｫ閾ｪ蜍慕噪縺ｫ繧ｭ繝｣繧ｹ繝医＆繧後∪縺吶?
111             *
112             * @return      蛻晄悄蛟､繧ｪ繝悶ず繧ｧ繧ｯ繝?
113             */
114            public T getDefault() {
115                    return defVal ;
116            }
117    
118            /**
119             * 險ｭ螳壹＠縺?T 縺悟ｭ伜惠縺励※縺?ｋ縺九←縺?°繧定ｿ斐＠縺ｾ縺吶?
120             * 蜀?Κ縺ｫ蛟､繧貞叙繧願ｾｼ繧薙□蠕後〒菴ｿ逕ｨ縺吶ｋ縲∝ｭ伜惠繝√ぉ繝?け縺ｧ縺吶?
121             * 騾壼ｸｸ縲］val 縺ｧ 蜿悶ｊ霎ｼ繧薙□蠕後?縲√メ繧ｧ繝?け荳崎ｦ√〒縺吶?
122             * 蠑墓焚縺?null 縺ｮ蝣ｴ蜷医?縲’alse 繧定ｿ斐＠縺ｾ縺吶?
123             *
124             * @param key T 險ｭ螳壹＠縺?T繧ｪ繝悶ず繧ｧ繧ｯ繝?
125             *
126             * @return      蟄伜惠縺吶ｋ:true / 蟄伜惠縺励↑縺?false
127             */
128            public boolean contains( final T key ) {
129                    if( key == null ) {
130                            return false;
131                    }
132                    return typemap.containsKey( String.valueOf( key ).toUpperCase( Locale.JAPAN ) );
133            }
134    
135            /**
136             * 蜀?Κ縺ｮ譁?ｭ怜?陦ｨ迴ｾ繧定ｿ斐＠縺ｾ縺吶?
137             *
138             * @return      蜀?Κ縺ｮ譁?ｭ怜?陦ｨ迴ｾ
139             */
140            @Override
141            public String toString() {
142    //              Types<T>[] types = typemap.values().toArray( new Types[typemap.size()] );
143    //              StringBuilder buf = new StringBuilder();
144    //              buf.append( CR );
145    //              for( int i=0; i<types.length; i++ ) {
146    //                      buf.append( SPACE ).append( types[i].toString() ).append( CR );
147    //              }
148    //              return buf.toString();
149    
150                    // 4.3.3.6 (2008/11/15) Generics隴ｦ蜻雁ｯｾ蠢?, toArray 縺九ｉ縲！terator 縺ｫ縲∝､画峩
151                    Iterator<Types<T>> ite = typemap.values().iterator();
152                    StringBuilder buf = new StringBuilder();
153                    buf.append( CR );
154                    while( ite.hasNext() ) {
155                            buf.append( SPACE ).append( ite.next() ).append( CR );
156                    }
157                    return buf.toString();
158            }
159    
160            /**
161             * 蜀?Κ繧ｪ繝悶ず繧ｧ繧ｯ繝医ｒ邂｡逅?☆繧狗ぜ縺ｮ 繧､繝ｳ繝翫?繧ｯ繝ｩ繧ｹ
162             * 繧ｭ繝ｼ繧ｪ繝悶ず繧ｧ繧ｯ繝医→縺昴?隱ｬ譏弱?繝壹い繧堤ｮ｡逅?＠縺ｾ縺吶?
163             *
164             * @version  4.0
165             * @author       Kazuhiko Hasegawa
166             * @since    JDK5.0,
167             */
168            private static class Types<T> {
169                    private final T key ;
170                    private final String msg ;
171    
172                    /**
173                     * 繧ｭ繝ｼ縺ｨ隱ｬ譏弱ｒ謖?ｮ壹＠縺溘さ繝ｳ繧ｹ繝医Λ繧ｯ繧ｿ
174                     *
175                     * @param key T 繧ｭ繝ｼ繧ｪ繝悶ず繧ｧ繧ｯ繝?
176                     * @param       msg     隱ｬ譏?
177                     * @throws IllegalArgumentException 繧ｭ繝ｼ繧ｪ繝悶ず繧ｧ繧ｯ繝医′null縺ｮ蝣ｴ蜷?
178                     */
179                    public Types( final T key,final String msg ) {
180                            if( key == null ) {
181                                    String errMsg = "key 縺ｫ縺ｯ null 繧偵そ繝?ヨ縺ｧ縺阪∪縺帙ｓ縲? ;
182                                    throw new IllegalArgumentException( errMsg );
183                            }
184    
185                            this.key = key;
186                            this.msg = msg;
187                    }
188    
189                    /**
190                     * 繧ｭ繝ｼ繧ｪ繝悶ず繧ｧ繧ｯ繝医ｒ霑斐＠縺ｾ縺吶?
191                     *
192                     * @return key T 繧ｭ繝ｼ繧ｪ繝悶ず繧ｧ繧ｯ繝?
193                     */
194                    public T getKey() { return key; }
195    
196                    /**
197                     * 隱ｬ譏弱ｒ霑斐＠縺ｾ縺吶?
198                     *
199                     * @return msg String 隱ｬ譏?
200                     */
201                    public String getMsg() { return msg; }
202    
203                    /**
204                     * 蜀?Κ縺ｮ譁?ｭ怜?陦ｨ迴ｾ繧定ｿ斐＠縺ｾ縺吶?
205                     *
206                     * @return      蜀?Κ縺ｮ譁?ｭ怜?陦ｨ迴ｾ
207                     */
208                    public String toString() {
209                            return key + " : " + msg ;
210                    }
211            }
212    }