Merge release/v3.122.2

[mikutoga/TogaGem.git] / src / main / java / jp / sfjp / mikutoga / xml / XmlExporter.java

diff --git a/src/main/java/jp/sfjp/mikutoga/xml/XmlExporter.java b/src/main/java/jp/sfjp/mikutoga/xml/XmlExporter.java
index fe52571..ae11217 100644 (file)
--- a/src/main/java/jp/sfjp/mikutoga/xml/XmlExporter.java
+++ b/src/main/java/jp/sfjp/mikutoga/xml/XmlExporter.java
@@ -22,7 +22,7 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putRawCh(char ch) throws IOException;
+    public abstract XmlExporter putRawCh(char ch) throws IOException;
 
     /**
      * 文字列を生出力する。
@@ -30,14 +30,15 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putRawText(CharSequence seq) throws IOException;
+    public abstract XmlExporter putRawText(CharSequence seq)
+            throws IOException;
 
     /**
      * 空白を出力する。
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter sp() throws IOException;
+    public abstract XmlExporter sp() throws IOException;
 
     /**
      * 空白を指定回数出力する。
@@ -45,27 +46,28 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter sp(int count) throws IOException;
+    public abstract XmlExporter sp(int count) throws IOException;
 
     /**
      * 改行文字列を返す。
      * @return 改行文字列
      */
-    String getNewLine();
+    public abstract String getNewLine();
 
     /**
      * 改行文字列を設定する。
      * @param newLine 改行文字列
      * @throws NullPointerException 引数がnull
      */
-    void setNewLine(String newLine) throws NullPointerException;
+    public abstract void setNewLine(String newLine)
+            throws NullPointerException;
 
     /**
      * 改行を出力する。
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter ln() throws IOException;
+    public abstract XmlExporter ln() throws IOException;
 
     /**
      * 改行を指定回数出力する。
@@ -73,39 +75,44 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter ln(int count) throws IOException;
+    public abstract XmlExporter ln(int count) throws IOException;
 
     /**
      * インデント単位文字列を返す。
      * @return インデント単位文字列
      */
-    String getIndentUnit();
+    public abstract String getIndentUnit();
 
     /**
      * インデント単位文字列を設定する。
+     *
      * <p>デフォルトでは空白2個。
+     *
      * @param indUnit インデント単位文字列。
      * @throws NullPointerException 引数がnull
      */
-    void setIndentUnit(String indUnit) throws NullPointerException;
+    public abstract void setIndentUnit(String indUnit)
+            throws NullPointerException;
 
     /**
      * インデントレベルを一段下げる。
      */
-    void pushNest();
+    public abstract void pushNest();
 
     /**
      * インデントレベルを一段上げる。
      * インデントレベル0の状態をさらに上げようとした場合、何も起こらない。
      */
-    void popNest();
+    public abstract void popNest();
 
     /**
      * インデントレベルを返す。
+     *
      * <p>深さ1の場合1を返す。
+     *
      * @return インデントレベル
      */
-    int getIndentLevel();
+    public abstract int getIndentLevel();
 
     /**
      * インデントを出力する。
@@ -113,28 +120,36 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter ind() throws IOException;
+    public abstract XmlExporter ind() throws IOException;
 
     /**
      * BasicLatin文字だけを出力する状態か判定する。
+     *
      * <p>コメント部中身は対象外。
+     *
      * @return BasicLatin文字だけで出力するならtrue
      */
-    boolean isBasicLatinOnlyOut();
+    public abstract boolean isBasicLatinOnlyOut();
 
     /**
      * BasicLatin文字だけで出力するか設定する。
+     *
      * <p>BasicLatin以外の文字(≒日本語)を、そのまま出力するか、
      * 文字参照で出力するか、の設定が可能。
+     *
      * <p>コメント部中身は対象外。
+     *
      * @param bool BasicLatin文字だけで出力するならtrue
      */
-    void setBasicLatinOnlyOut(boolean bool);
+    public abstract void setBasicLatinOnlyOut(boolean bool);
 
     /**
      * 指定された文字を16進2桁の文字参照形式で出力する。
+     *
      * <p>「A」は「&amp;#x41;」になる。
+     *
      * <p>2桁で出力できない場合(&gt;0x00ff)は4桁で出力する。
+     *
      * @param ch 文字
      * @return this本体
      * @throws IOException 出力エラー
@@ -142,12 +157,15 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * W3C XML1.1 Character Reference
      * </a>
      */
-    XmlExporter putCharRef2Hex(char ch) throws IOException;
+    public abstract XmlExporter putCharRef2Hex(char ch) throws IOException;
 
     /**
      * 指定された文字を16進4桁の文字参照形式で出力する。
+     *
      * <p>「亜」は「&amp;#x4E9C;」になる。
+     *
      * <p>UCS4に伴うサロゲートペアは未サポート
+     *
      * @param ch 文字
      * @return this本体
      * @throws IOException 出力エラー
@@ -155,38 +173,51 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * W3C XML1.1 Character Reference
      * </a>
      */
-    XmlExporter putCharRef4Hex(char ch) throws IOException;
+    public abstract XmlExporter putCharRef4Hex(char ch) throws IOException;
 
     /**
      * 要素の中身および属性値中身を出力する。
+     *
      * <p>XMLの構文規則を守る上で必要な各種エスケープ処理が行われる。
+     *
      * @param ch 文字
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putCh(char ch) throws IOException;
+    public abstract XmlExporter putCh(char ch) throws IOException;
 
     /**
      * 要素の中身および属性値中身を出力する。
+     *
      * <p>必要に応じてXML定義済み実体文字が割り振られた文字、
      * コントロールコード、および非BasicLatin文字がエスケープされる。
+     *
      * <p>半角円通貨記号U+00A5はバックスラッシュU+005Cに置換される。
+     *
      * <p>連続するスペースU+0020の2文字目以降は文字参照化される。
+     *
      * <p>全角スペースその他空白文字は無条件に文字参照化される。
+     *
      * @param content 内容
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putContent(CharSequence content) throws IOException;
+    public abstract XmlExporter putContent(CharSequence content)
+            throws IOException;
 
     /**
      * コメントの内容を出力する。
+     *
      * <p>コメント中の'\n'記号出現に伴い、
      * あらかじめ指定された改行文字が出力される。
+     *
      * <p>コメント中の'\n'以外のコントロールコードは
      * Control Pictures(U+2400〜)で代替される。
+     *
      * <p>それ以外の非BasicLatin文字はそのまま出力される。
+     *
      * <p>連続するハイフン(-)記号間には強制的にスペースが挿入される。
+     *
      * @param comment コメント内容
      * @return this本体
      * @throws IOException 出力エラー
@@ -194,7 +225,8 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * Unicode 6.2 Controll Pictures
      * </a>
      */
-    XmlExporter putCommentContent(CharSequence comment) throws IOException;
+    public abstract XmlExporter putCommentContent(CharSequence comment)
+            throws IOException;
 
     /**
      * 1行コメントを出力する。
@@ -203,19 +235,26 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putLineComment(CharSequence comment) throws IOException;
+    public abstract XmlExporter putLineComment(CharSequence comment)
+            throws IOException;
 
     /**
      * ブロックコメントを出力する。
+     *
      * <p>コメント内部の頭の前に改行が出力される。
+     *
      * <p>コメント内部の末尾が改行でない場合、改行が挿入される。
+     *
      * <p>ブロックコメント末尾は改行で終わる。
+     *
      * <p>インデント設定は無視される。
+     *
      * @param comment コメント内容
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putBlockComment(CharSequence comment) throws IOException;
+    public abstract XmlExporter putBlockComment(CharSequence comment)
+            throws IOException;
 
     /**
      * 開始タグ開き表記を出力する。
@@ -223,14 +262,15 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putOpenSTag(CharSequence tagName) throws IOException;
+    public abstract XmlExporter putOpenSTag(CharSequence tagName)
+            throws IOException;
 
     /**
      * 開始タグ閉じ表記を出力する。
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putCloseSTag() throws IOException;
+    public abstract XmlExporter putCloseSTag() throws IOException;
 
     /**
      * 属性の無いシンプルな開始タグ表記を出力する。
@@ -238,7 +278,8 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putSimpleSTag(CharSequence tagName) throws IOException;
+    public abstract XmlExporter putSimpleSTag(CharSequence tagName)
+            throws IOException;
 
     /**
      * 終了タグ表記を出力する。
@@ -246,7 +287,8 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putETag(CharSequence tagName) throws IOException;
+    public abstract XmlExporter putETag(CharSequence tagName)
+            throws IOException;
 
     /**
      * 属性の無い単出タグ表記を出力する。
@@ -254,14 +296,15 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putSimpleEmpty(CharSequence tagName) throws IOException;
+    public abstract XmlExporter putSimpleEmpty(CharSequence tagName)
+            throws IOException;
 
     /**
      * 単出タグ閉じ表記を出力する。
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putCloseEmpty() throws IOException;
+    public abstract XmlExporter putCloseEmpty() throws IOException;
 
     /**
      * xsd:int値をXMLスキーマ準拠の形式で出力する。
@@ -272,7 +315,7 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * XML Schema 1.1 Datatypes int
      * </a>
      */
-    XmlExporter putXsdInt(int iVal) throws IOException;
+    public abstract XmlExporter putXsdInt(int iVal) throws IOException;
 
     /**
      * xsd:float値をXMLスキーマ準拠の形式で出力する。
@@ -283,7 +326,7 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * XML Schema 1.1 Datatypes float Lexical Mapping
      * </a>
      */
-    XmlExporter putXsdFloat(float fVal) throws IOException;
+    public abstract XmlExporter putXsdFloat(float fVal) throws IOException;
 
     /**
      * int型属性値を出力する。
@@ -292,7 +335,7 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putIntAttr(CharSequence attrName, int iVal)
+    public abstract XmlExporter putIntAttr(CharSequence attrName, int iVal)
             throws IOException;
 
     /**
@@ -302,7 +345,8 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putFloatAttr(CharSequence attrName, float fVal)
+    public abstract XmlExporter putFloatAttr(
+            CharSequence attrName, float fVal)
             throws IOException;
 
     /**
@@ -312,7 +356,8 @@ public interface XmlExporter extends Appendable, Flushable, Closeable{
      * @return this本体
      * @throws IOException 出力エラー
      */
-    XmlExporter putAttr(CharSequence attrName, CharSequence content)
+    public abstract XmlExporter putAttr(
+            CharSequence attrName, CharSequence content)
             throws IOException;
 
 }