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 * TagBuffer.java は、å?通的に使用されã‚?簡易タグ作æ?クラスですã?
020 * タグヘッãƒ??は、オブジェクト作æ?時に登録する為、後ã?変更は出来ませんã€?
021 * BODY部ã‚??属æ?は、ä¸?º¦登録すると書き換えできませんã€?
022 * またã?同ä¸?±žæ?チェãƒ?‚¯は行いません。登録した属æ?のキーã‚??値を取りå?すこともå?来ませんã€?
023 * あくまで、タグæ–?—å?をストレートに作æ?することに特化したクラスですã?
024 * これらã?高度な機è?がå¿?¦�であれば、{@link org.opengion.fukurou.util.Attributes } をご参ç?くださいã€?
025 *
026 * makeTag() メソãƒ?ƒ‰を呼び出した時点で、å?部にタグæ–?—å?をキャãƒ?‚·ュしますã?
027 * それ以降ã?変更は、å?来ませんã€?
028 *
029 * å†?ƒ¨çš?�«は、構é?化されてã�?�¾せん。あくまで、文字å?連çµ?StringBuilder)の
030 * 簡易クラスとして、使用してくださいã€?
031 *
032 * @og.group ユーãƒ?‚£リãƒ?‚£
033 *
034 * @version 4.0
035 * @author Kazuhiko Hasegawa
036 * @since JDK5.0,
037 */
038 public final class TagBuffer {
039 private final StringBuilder buf = new StringBuilder(100);
040 private final String tagName ;
041 private String body = null;
042 private String cacheTag = null;
043
044 /**
045 * ãƒ?ƒ•ォルトコンストラクター
046 * こã?コンストラクターを使用すると、タグ名をæŒ?®šできなã�?�Ÿめã?
047 * 完æ?形のタグは、作æ?できません。属æ?リスãƒ?key="value")の
048 * 連結形式を得る場合にのみ、使用して下さã�??
049 *
050 */
051 public TagBuffer() {
052 this.tagName = null;
053 }
054
055 /**
056 * コンストラクター
057 * タグ名に null を指定すると、デフォルトコンストラクターと同様にã€?
058 * 完æ?形のタグは、作æ?できません。属æ?リスãƒ?key="value")の
059 * 連結形式を得る場合にのみ、タグå�?にnull を指定して下さã�??
060 *
061 * @param tagName タグ名称
062 */
063 public TagBuffer( final String tagName ) {
064 this.tagName = tagName;
065 if( tagName != null ) {
066 buf.append( "<" ).append( tagName ).append( " " );
067 }
068 }
069
070 /**
071 * タグの BODY部を登録しますã?
072 * 登録しなã�??合ã?、BODY部のなã�?‚¿グ(空要ç´?‚¿グ)を生成しますã?
073 * BODY部を指定するとã€?lt;tagName key="val" ?¥?¥?¥ >body</tagName> 形式になりますã?
074 * BODY部がã?null の場合ã?ã€?<tagName key="val" ?¥?¥?¥ /> 形式になりますã?
075 * こã?メソãƒ?ƒ‰は、makeTag() が呼ばれた後ã?、登録できなくなりますã?
076 *
077 * @param body タグのBODY部
078 */
079 public void setBody( final String body ) {
080 if( cacheTag != null ) {
081 String errMsg = "makeTag() 実行後に、BODY部の値を書き換えることは出来ませんã€? ;
082 throw new RuntimeException( errMsg );
083 }
084
085 this.body = body;
086 }
087
088 /**
089 * タグの 属æ?(key="value")を登録しますã?
090 * 属æ?は、key="value" のæ–?—å?を作æ?しますã?key かã?value のどちらかã�?null
091 * の場合ã?、登録しませんã€?
092 * value に、ダブルコーãƒ??ション(")が含まれてã�?‚‹場合ã?、属æ?値をシングルコーãƒ??ション
093 * でくくりますã?
094 * 両方含まれてã�?‚‹場合ã?、シングルコーãƒ??ションをエスケープ文字に変換しますã?
095 * こã?メソãƒ?ƒ‰は、makeTag() が呼ばれた後ã?、登録できなくなりますã?
096 *
097 * @og.rev 3.8.6.1 (2006/10/20) シングルとãƒ?ƒ–ルが混在する場合ã?、シングルをエスケープすã‚?
098 *
099 * @param key 属æ?キー (null の場合ã?、なにもしなã�?
100 * @param val 属æ?値 (null の場合ã?、なにもしなã�?
101 */
102 public void add( final String key,final String val ) {
103 if( cacheTag != null ) {
104 String errMsg = "makeTag() 実行後に、属æ?を追åŠ?�™ることは出来ませんã€? ;
105 throw new RuntimeException( errMsg );
106 }
107
108 if( key != null && val != null ) {
109 if( val.indexOf( '\"' ) >= 0 ) {
110 String temp = val ;
111 if( val.indexOf( "'" ) >= 0 ) { temp = val.replaceAll( "'","'" ); }
112 buf.append( key ).append( "='" ).append( temp ).append( "' " );
113 }
114 else {
115 buf.append( key ).append( "=\"" ).append( val ).append( "\" " );
116 }
117 }
118 }
119
120 /**
121 * タグの属æ?に、追åŠ?™»録しますã?
122 * æ–?—å?として、key="value" の形式データを与えてください。é?結時は、後ろに
123 * スペã?スをä¸?�¤挟みますã?で、与える引数自体に連結用スペã?スを追åŠ?�—ておく
124 * å¿?¦�ã?ありませんã€?
125 * 通常は、tagName なしで作æ?した、Tagbuffer オブジェクトã? makeTag() メソãƒ?ƒ‰の
126 * 返り値を渡しますが、Attributes.getAttribute() の返り値でも使用できますã?
127 * 引数ã�?null の場合ã?、なにもしませんã€?
128 * こã?メソãƒ?ƒ‰は、makeTag() が呼ばれた後ã?、登録できなくなりますã?
129 *
130 * @param str タグバッファーを追åŠ?�—ますã?
131 * @see #makeTag()
132 * @see Attributes#getAttribute()
133 */
134 public void add( final String str ) {
135 if( cacheTag != null ) {
136 String errMsg = "makeTag() 実行後に、属æ?を追åŠ?�™ることは出来ませんã€? ;
137 throw new RuntimeException( errMsg );
138 }
139
140 if( str != null ) {
141 buf.append( str ).append( " " );
142 }
143 }
144
145 /**
146 * タグの 整形された文字å?ã‚?作æ?しますã?
147 * こã?メソãƒ?ƒ‰は、tagName,body,属æ?より タグの完æ?形のæ–?—å?を作æ?しますã?
148 * 作æ?された文字å?は、å?部でキャãƒ?‚·ュされますã?
149 * BODY部を指定するとã€?lt;tagName key="val" ?¥?¥?¥ >body</tagName> 形式になりますã?
150 * BODY部がã?null の場合ã?ã€?<tagName key="val" ?¥?¥?¥ /> 形式になりますã?
151 * タグ名をæŒ?®šしなã�?null)と、完æ?形のタグは、作æ?できませんã€?
152 * 属æ?リスãƒ?key="value")の連結形式を返しますã?
153 *
154 * こã?メソãƒ?ƒ‰の呼び出し以降では、setBody() ã‚?add() も実行できませんã€?
155 *
156 * @return 整形されã�?タグæ–?—å?
157 */
158 public String makeTag() {
159 if( cacheTag == null ) {
160 if( tagName != null ) {
161 if( body == null ) {
162 buf.append( "/>" );
163 }
164 else {
165 buf.append( ">" ).append( body );
166 buf.append( "</" ).append( tagName ).append( ">" );
167 }
168 }
169 cacheTag = buf.toString();
170 }
171
172 return cacheTag;
173 }
174
175 /**
176 * 行番号付きのタグの 整形された文字å?ã‚?作æ?しますã?
177 * こã?メソãƒ?ƒ‰は、makeTag() の結果より、[I] æ–?—å?を引数の行番号と変換しますã?
178 * これにより、動çš?�«行番号つきã?æƒ??を属æ?に付与することが可能になりますã?
179 * å†?ƒ¨にキャãƒ?‚·ュされるå?は、[I] 記号を変換してã�?�ªã�?ж態ã?æ–?—å?ですã?
180 * よって、このメソãƒ?ƒ‰は、rowNo を変えて、何度でも呼び出すことは可能ですがã€?
181 * setBody() ã‚?add() は実行できませんã€?
182 *
183 * @param rowNo 行番号([I] æ–?—å?を変換しますã?)
184 * @param val 設定å?([V] æ–?—å?を変換しますã?)
185 *
186 * @return 整形されã�?タグæ–?—å?
187 */
188 public String makeTag( final int rowNo,final String val ) {
189 String tag = makeTag();
190 tag = StringUtil.replace( tag,"[I]",String.valueOf( rowNo ) );
191 tag = StringUtil.replace( tag,"[V]",val );
192
193 return tag ;
194 }
195 }