X-Git-Url: http://git.osdn.net/view?p=mikutoga%2FTogaGem.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fjp%2Fsfjp%2Fmikutoga%2Fxml%2FXmlExporter.java;fp=src%2Fmain%2Fjava%2Fjp%2Fsfjp%2Fmikutoga%2Fxml%2FXmlExporter.java;h=2fe64280a32b9ec1c5057ff229d3330b277d825e;hp=fe52571198b2aecb886da3584123106457133eb3;hb=3fd0f125fb25fb0955bf2d7f7a557f488b4fd98a;hpb=28e5e9073269dfd1a816329411073c704e58c777 diff --git a/src/main/java/jp/sfjp/mikutoga/xml/XmlExporter.java b/src/main/java/jp/sfjp/mikutoga/xml/XmlExporter.java index fe52571..2fe6428 100644 --- a/src/main/java/jp/sfjp/mikutoga/xml/XmlExporter.java +++ b/src/main/java/jp/sfjp/mikutoga/xml/XmlExporter.java @@ -83,7 +83,9 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{ /** * インデント単位文字列を設定する。 + * *

デフォルトでは空白2個。 + * * @param indUnit インデント単位文字列。 * @throws NullPointerException 引数がnull */ @@ -102,7 +104,9 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{ /** * インデントレベルを返す。 + * *

深さ1の場合1を返す。 + * * @return インデントレベル */ int getIndentLevel(); @@ -117,24 +121,32 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{ /** * BasicLatin文字だけを出力する状態か判定する。 + * *

コメント部中身は対象外。 + * * @return BasicLatin文字だけで出力するならtrue */ boolean isBasicLatinOnlyOut(); /** * BasicLatin文字だけで出力するか設定する。 + * *

BasicLatin以外の文字(≒日本語)を、そのまま出力するか、 * 文字参照で出力するか、の設定が可能。 + * *

コメント部中身は対象外。 + * * @param bool BasicLatin文字だけで出力するならtrue */ void setBasicLatinOnlyOut(boolean bool); /** * 指定された文字を16進2桁の文字参照形式で出力する。 + * *

「A」は「A」になる。 + * *

2桁で出力できない場合(>0x00ff)は4桁で出力する。 + * * @param ch 文字 * @return this本体 * @throws IOException 出力エラー @@ -146,8 +158,11 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{ /** * 指定された文字を16進4桁の文字参照形式で出力する。 + * *

「亜」は「亜」になる。 + * *

UCS4に伴うサロゲートペアは未サポート + * * @param ch 文字 * @return this本体 * @throws IOException 出力エラー @@ -159,7 +174,9 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{ /** * 要素の中身および属性値中身を出力する。 + * *

XMLの構文規則を守る上で必要な各種エスケープ処理が行われる。 + * * @param ch 文字 * @return this本体 * @throws IOException 出力エラー @@ -168,11 +185,16 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{ /** * 要素の中身および属性値中身を出力する。 + * *

必要に応じてXML定義済み実体文字が割り振られた文字、 * コントロールコード、および非BasicLatin文字がエスケープされる。 + * *

半角円通貨記号U+00A5はバックスラッシュU+005Cに置換される。 + * *

連続するスペースU+0020の2文字目以降は文字参照化される。 + * *

全角スペースその他空白文字は無条件に文字参照化される。 + * * @param content 内容 * @return this本体 * @throws IOException 出力エラー @@ -181,12 +203,17 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{ /** * コメントの内容を出力する。 + * *

コメント中の'\n'記号出現に伴い、 * あらかじめ指定された改行文字が出力される。 + * *

コメント中の'\n'以外のコントロールコードは * Control Pictures(U+2400〜)で代替される。 + * *

それ以外の非BasicLatin文字はそのまま出力される。 + * *

連続するハイフン(-)記号間には強制的にスペースが挿入される。 + * * @param comment コメント内容 * @return this本体 * @throws IOException 出力エラー @@ -207,10 +234,15 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{ /** * ブロックコメントを出力する。 + * *

コメント内部の頭の前に改行が出力される。 + * *

コメント内部の末尾が改行でない場合、改行が挿入される。 + * *

ブロックコメント末尾は改行で終わる。 + * *

インデント設定は無視される。 + * * @param comment コメント内容 * @return this本体 * @throws IOException 出力エラー