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.Set;
019    import java.util.TreeSet;
020    import java.util.Iterator;
021    
022    /**
023     * ReplaceString.java 縺ｯ縲∬､?焚縺ｮ譁?ｭ怜?繧剃ｸ?峡鄂ｮ謠帙☆繧句?蜷医↓菴ｿ逕ｨ縺吶ｋ繧ｯ繝ｩ繧ｹ縺ｧ縺吶?
024     *
025     * add 繝｡繧ｽ繝?ラ縺ｧ縲?幕蟋九い繝峨Ξ繧ｹ縲∫ｵゆｺ?い繝峨Ξ繧ｹ縲∫ｽｮ謠帶枚蟄怜?繧呈欠螳壹＠縲?
026     * 譛?ｾ後↓縲〉eplaceAll 縺ｧ縲∝､画鋤繧定｡後＞縺ｾ縺吶?
027     * 騾壼ｸｸ縲∫焚縺ｪ繧区枚蟄怜?繧剃ｸ?峡縺ｧ螟画鋤縺吶ｋ蝣ｴ蜷医?騾??縺ｫ螟画鋤繧｢繝峨Ξ繧ｹ繧呈ｱゅａ縺ｦ縲?
028     * 蠕後ｍ縺九ｉ鬆?↓鄂ｮ謠帙＠縺ｦ縺?°縺ｪ縺?→縲∝燕縺九ｉ蜃ｦ逅?☆繧九→蜃ｦ逅?＃縺ｨ縺ｫ繧｢繝峨Ξ繧ｹ縺?
029     * 螟画峩縺ｫ縺ｪ繧贋ｸ?°繧牙?險育ｮ励☆繧九％縺ｨ縺ｫ縺ｪ繧翫∪縺吶?縺薙ｌ縺ｯ縲∫匳骭ｲ譎ゅ?縲√←縺ｮ繧医≧縺ｪ
030     * 鬆?ｺ上〒繧ゅｈ縺上?replaceAll 譎ゅ↓縲∝?驛ｨ縺ｫ逋ｻ骭ｲ謖?ｮ壹≠繧句､画鋤譁?ｭ怜?縺ｮ髢句ｧ九い繝峨Ξ繧ｹ繧医ｊ
031     * 閾ｪ蜍慕噪縺ｫ騾??縺ｧ鄂ｮ謠帙☆繧九◆繧√?隍?焚縺ｮ鄂ｮ謠帛?謇?′縺ゅ▲縺ｦ繧ゅ?縺ｾ縺ｨ繧√※蜃ｦ逅?〒縺阪∪縺吶?
032     * 縺溘□縺励?隍?焚縺ｮ鄂ｮ謠帛?謇?′縺ゅｋ蝣ｴ蜷医?驥崎､?ｦ∫ｴ?′縺ゅｌ縺ｰ縲√お繝ｩ繝ｼ縺ｫ縺ｪ繧翫∪縺吶?
033     *
034     * @version  4.0
035     * @author       Kazuhiko Hasegawa
036     * @since    JDK5.0,
037     */
038    public final class ReplaceString {
039            private final Set<ReplaceData> set = new TreeSet<ReplaceData>();
040    
041            /**
042             * 髢句ｧ九い繝峨Ξ繧ｹ縲∫ｵゆｺ?い繝峨Ξ繧ｹ縲∫ｽｮ謠帶枚蟄怜?繧呈欠螳壹＠鄂ｮ謠帛ｯｾ雎｡繧定ｿｽ蜉?＠縺ｾ縺吶?
043             * 騾壼ｸｸ縲∵枚蟄怜?繧堤ｽｮ謠帙☆繧九→縲∝?縺ｮ繧｢繝峨Ξ繧ｹ縺ｨ縺壹ｌ繧九?繧帝亟縺千ぜ縲?
044             * 蠕後ｍ縺九ｉ縲∫ｽｮ謠帙ｒ陦後＞縺ｾ縺吶?荳?峡鄂ｮ謠帙?縲∬､?焚縺ｮ譁?ｭ怜?鄂ｮ謠帙ｒ縲?幕蟋九い繝峨Ξ繧ｹ縺ｮ
045             * 蠕後ｍ縺九ｉ縲∫ｽｮ謠帙ｒ蟋九ａ繧狗ぜ縺ｮ縲∝?譛溘ョ繝ｼ繧ｿ繧堤匳骭ｲ縺励∪縺吶?
046             * 逋ｻ骭ｲ鬆??縲∫ｽｮ謠幃?縺ｨ縺ｯ辟｡髢｢菫ゅ↓險ｭ螳壼庄閭ｽ縺ｧ縺吶?
047             *
048             * @param       start   鄂ｮ謠幃幕蟋九い繝峨Ξ繧ｹ
049             * @param       end     鄂ｮ謠帷ｵゆｺ?い繝峨Ξ繧ｹ
050             * @param       newStr  鄂ｮ謠帶枚蟄怜?
051             */
052            public void add( final int start, final int end, final String newStr ) {
053                    set.add( new ReplaceData( start, end, newStr ) );
054            }
055    
056            /**
057             * 鄂ｮ謠帛?譁?ｭ怜?繧呈欠螳壹＠縺ｦ縲∫ｽｮ謠帛?逅?ｒ螳溯｡後＠縺ｾ縺吶?
058             * add 繝｡繧ｽ繝?ラ縺ｧ謖?ｮ壹＠縺滓枚蟄怜?繧貞ｮ滄圀縺ｫ鄂ｮ謠帛?逅?＠縺ｾ縺吶?
059             *
060             * @param       target  鄂ｮ謠帛?譁?ｭ怜?
061             *
062             * @return      鄂ｮ謠帛ｾ梧枚蟄怜?
063             */
064            public String replaceAll( final String target ) {
065                    Iterator<ReplaceData> ite = set.iterator();
066                    StringBuilder buf = new StringBuilder( target );
067                    while( ite.hasNext() ) {
068                            ReplaceData data = ite.next();
069                            buf = data.replace( buf );
070                    }
071                    return buf.toString();
072            }
073    
074            /**
075             * 鄂ｮ謠帶枚蟄怜?繧堤ｮ｡逅?☆繧句?驛ｨ繧ｯ繝ｩ繧ｹ
076             *
077             * @version  4.0
078             * @author       Kazuhiko Hasegawa
079             * @since    JDK5.0,
080             */
081            private static class ReplaceData implements Comparable<ReplaceData> {
082                    private final int start     ;
083                    private final int end       ;
084                    private final String newStr ;
085                    private final int hCode  ;
086    
087                    /**
088                     * 髢句ｧ九い繝峨Ξ繧ｹ縲∫ｵゆｺ?い繝峨Ξ繧ｹ縲∫ｽｮ謠帶枚蟄怜?繧呈欠螳壹＠縺ｾ縺吶?
089                     * 騾壼ｸｸ縲∵枚蟄怜?繧堤ｽｮ謠帙☆繧九→縲∝?縺ｮ繧｢繝峨Ξ繧ｹ縺ｨ縺壹ｌ繧九?繧帝亟縺千ぜ縲?
090                     * 蠕後ｍ縺九ｉ縲∫ｽｮ謠帙ｒ陦後＞縺ｾ縺吶?荳?峡鄂ｮ謠帙?縲∬､?焚縺ｮ譁?ｭ怜?鄂ｮ謠帙ｒ縲?幕蟋九い繝峨Ξ繧ｹ縺ｮ
091                     * 蠕後ｍ縺九ｉ縲∫ｽｮ謠帙ｒ蟋九ａ繧狗ぜ縺ｮ縲∝?譛溘ョ繝ｼ繧ｿ繧堤匳骭ｲ縺励∪縺吶?
092                     * 逋ｻ骭ｲ鬆??縲∫ｽｮ謠幃?縺ｨ縺ｯ辟｡髢｢菫ゅ↓險ｭ螳壼庄閭ｽ縺ｧ縺吶?
093                     *
094                     * @param       start   鄂ｮ謠幃幕蟋九い繝峨Ξ繧ｹ
095                     * @param       end     鄂ｮ謠帷ｵゆｺ?い繝峨Ξ繧ｹ
096                     * @param       newStr  鄂ｮ謠帶枚蟄怜?
097                     */
098                    public ReplaceData( final int start, final int end, final String newStr ) {
099                            this.start  = start;
100                            this.end    = end;
101                            this.newStr = newStr ;
102                            hCode    = ( newStr + start + "_" + end ).hashCode();
103                    }
104    
105                    /**
106                     * 鄂ｮ謠帛?逅?ｒ螳溯｡後＠縺ｾ縺吶?
107                     *
108                     * @param   buf StringBuilder 蜈･蜉帶枚蟄怜?
109                     * @return      蜃ｺ蜉帶枚蟄怜?
110                     */
111                    public StringBuilder replace( final StringBuilder buf ) {
112                            return buf.replace( start,end,newStr );
113                    }
114    
115                    /**
116                     * 謖?ｮ壹?ReplaceData縺ｮ髢句ｧ?邨ゆｺ?′驥阪↑縺｣縺ｦ縺?ｋ縺九←縺?°繧貞愛螳壹＠縺ｾ縺吶?
117                     *
118                     * @og.rev 5.7.2.1 (2014/01/17) 蛻､螳夂ｵ先棡縺ｮ true/false 縺悟渚霆｢縺励※縺?◆縺ｮ縺ｧ縲∽ｿｮ豁｣
119                     *
120                     * @param   other ReplaceData 蜈･蜉帶枚蟄怜?
121                     * @return      繧ｪ繝ｼ繝舌?繝ｩ繝??縺励※縺?ｋ縺九←縺?°(true:荳肴ｭ｣/false:豁｣蟶ｸ)
122                     */
123                    public boolean isOverlap( final ReplaceData other ) {
124    //                      return  ! ( ( other == null ) || ( other.end < start ) || ( end < other.start ) );
125    //                      return  ( ( other == null ) || ( other.end < start ) || ( end < other.start ) );
126                            return  ( other == null ) || ! ( ( other.end < start ) || ( end < other.start ) );
127    
128                    }
129    
130                    /**
131                     * 閾ｪ辟ｶ豈碑ｼ?Γ繧ｽ繝?ラ
132                     * 繧､繝ｳ繧ｿ繝輔ぉ繝ｼ繧ｹ Comparable 縺ｮ 螳溯｣?〒縺吶?
133                     * 逋ｻ骭ｲ縺輔ｌ縺滄幕蟋九い繝峨Ξ繧ｹ縺ｮ髯埼?縺ｫ縺ｪ繧九ｈ縺?↓豈碑ｼ?＠縺ｾ縺吶?
134                     * 縺ｪ縺翫?豈碑ｼ?ｯｾ辣ｧ繧ｪ繝悶ず繧ｧ繧ｯ繝医→繧ｪ繝ｼ繝舌?繝ｩ繝??縺励※縺?ｋ蝣ｴ蜷医?縲?
135                     * 豈碑ｼ?〒縺阪↑縺?→縺励※縲！llegalArgumentException 繧堤匱陦後＠縺ｾ縺吶?
136                     *
137                     * @og.rev 5.7.4.0 (2014/03/07) 蜷御ｸ?が繝悶ず繧ｧ繧ｯ繝医?蛻､螳壹ｒ霑ｽ蜉?
138                     *
139                     * @param   other 豈碑ｼ?ｯｾ雎｡縺ｮObject
140                     * @return  髢句ｧ九い繝峨Ξ繧ｹ縺ｮ髯埼?(閾ｪ蛻??繧｢繝峨Ξ繧ｹ縺悟ｰ上＆縺??蜷医?縲?ｼ?
141                     * @throws      IllegalArgumentException  蠑墓焚繧ｪ繝悶ず繧ｧ繧ｯ繝医′繧ｪ繝ｼ繝舌?繝ｩ繝??縺励※縺?ｋ蝣ｴ蜷?
142                     */
143                    public int compareTo( final ReplaceData other ) {
144                            if( other == null ) {
145                                    String errMsg = "蠑墓焚縺ｫ null 縺ｯ險ｭ螳壹〒縺阪∪縺帙ｓ縲? ;
146                                    throw new IllegalArgumentException( errMsg );
147                            }
148    
149                            // 5.7.4.0 (2014/03/07) 蜷御ｸ?が繝悶ず繧ｧ繧ｯ繝医?蛻､螳壹ｒ霑ｽ蜉?
150                            if( other.hCode == hCode ) { return 0; }
151    
152                            if( isOverlap( other) ) {
153                                    String errMsg = "豈碑ｼ?ｯｾ辣ｧ繧ｪ繝悶ず繧ｧ繧ｯ繝医→繧ｪ繝ｼ繝舌?繝ｩ繝??縺励※縺?∪縺吶?"
154                                                            + " this =[" + start + "],[" + end + "],[" + newStr + "]"
155                                                            + " other=[" + other.start + "],[" + other.end + "],[" + other.newStr + "]" ;
156                                    throw new IllegalArgumentException( errMsg );
157                            }
158                            return other.start - start;             // 髢句ｧ矩?縺ｮ髯埼?
159                    }
160    
161                    /**
162                     * 縺薙?繧ｪ繝悶ず繧ｧ繧ｯ繝医→莉悶?繧ｪ繝悶ず繧ｧ繧ｯ繝医′遲峨＠縺?°縺ｩ縺?°繧堤､ｺ縺励∪縺吶?
163                     * 繧､繝ｳ繧ｿ繝輔ぉ繝ｼ繧ｹ Comparable 縺ｮ 螳溯｣?↓髢｢騾｣縺励※縲∝?螳夂ｾｩ縺励※縺?∪縺吶?
164                     *
165                     * @param   other 豈碑ｼ?ｯｾ雎｡縺ｮ蜿ら?繧ｪ繝悶ず繧ｧ繧ｯ繝?
166                     * @return  obj 蠑墓焚縺ｫ謖?ｮ壹＆繧後◆繧ｪ繝悶ず繧ｧ繧ｯ繝医→縺薙?繧ｪ繝悶ず繧ｧ繧ｯ繝医′遲峨＠縺??蜷医? true縲√◎縺?〒縺ｪ縺??蜷医? false
167                     *
168                     */
169                    public boolean equals( final Object object ) {
170                            if( object instanceof ReplaceData ) {
171                                    ReplaceData other = (ReplaceData)object ;
172                                    return start == other.start &&
173                                                    end == other.end    &&
174                                                    newStr.equals( other.newStr ) ;
175                            }
176                            return false ;
177                    }
178    
179                    /**
180                     * 繧ｪ繝悶ず繧ｧ繧ｯ繝医?繝上ャ繧ｷ繝･繧ｳ繝ｼ繝牙?繧定ｿ斐＠縺ｾ縺吶?
181                     * 縺薙?繝｡繧ｽ繝?ラ縺ｯ縲）ava.util.Hashtable 縺ｫ繧医▲縺ｦ謠蝉ｾ帙＆繧後ｋ繧医≧縺ｪ
182                     * 繝上ャ繧ｷ繝･繝??繝悶Ν縺ｧ菴ｿ逕ｨ縺吶ｋ縺溘ａ縺ｫ逕ｨ諢上＆繧後※縺?∪縺吶?
183                     * equals( Object ) 繝｡繧ｽ繝?ラ繧偵が繝ｼ繝舌?繝ｩ繧､繝医＠縺溷?蜷医?縲”ashCode() 繝｡繧ｽ繝?ラ繧?
184                     * 蠢?★ 險倩ｿｰ縺吶ｋ蠢?ｦ√′縺ゅｊ縺ｾ縺吶?
185                     *
186                     *
187                     * @return  縺薙?繧ｪ繝悶ず繧ｧ繧ｯ繝医?繝上ャ繧ｷ繝･繧ｳ繝ｼ繝牙?
188                     *
189                     */
190                    public int hashCode() {
191                            return hCode ;
192                    }
193            }
194    }