パッケージ org.opengion.fukurou.taglet

## クラス DocletTagWriter

- java.lang.Object
- - org.opengion.fukurou.taglet.DocletTagWriter

-     public final class DocletTagWriter
      extends java.lang.Object

  Tag 情報を出力する PrintWriter 相当クラスです。
  導入されたバージョン:
    JDK5.0,

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールド | 説明
    --- | --- | ---
    `static java.lang.String` | `BR` | HTML上のブレーク <br> + CR

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタ | 説明
    --- | ---
    `DocletTagWriter​(java.lang.String file)` | Doclet のエントリポイントメソッドです。
    `DocletTagWriter​(java.lang.String file, java.lang.String encode)` | Doclet のエントリポイントメソッドです。
    `DocletTagWriter​(java.lang.String file, java.lang.String encode, boolean r2b)` | Doclet のエントリポイントメソッドです。

  - ### メソッドの概要

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `void` | `close()` | 出力ファイルをクロースします。
    `void` | `printChar​(java.lang.String str1, com.sun.javadoc.Tag[] tag, java.lang.String str3)` | 文字列引数を ２つと、タグ配列を受け取り、先頭一文字のタグ出力します。
    `void` | `printCSVTag​(com.sun.javadoc.Tag... tag)` | タグ配列を受け取り、タグ出力します。
    `void` | `printTag​(com.sun.javadoc.Tag... tag)` | タグ配列を受け取り、タグ出力します。
    `void` | `printTag​(java.lang.String... str)` | 可変長の文字列引数を取り、文字列を出力します。
    `void` | `printTag​(java.lang.String str1, com.sun.javadoc.Tag[] tag, java.lang.String str3)` | 文字列引数を ２つと、タグ配列を受け取り、タグ出力します。
    `void` | `printTagsInfo​(com.sun.javadoc.Tag... tag)` | タグ配列を受け取り、タグ出力します。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### BR

          public static final java.lang.String BR

      HTML上のブレーク <br> + CR

  - ### コンストラクタの詳細

    - #### DocletTagWriter

          public DocletTagWriter​(java.lang.String file)
                          throws java.io.IOException

      Doclet のエントリポイントメソッドです。 初期エンコードで出力します。
      パラメータ:
        `file` - 出力ファイル名
      例外:
        `java.io.IOException` - なんらかのエラーが発生した場合。

    - #### DocletTagWriter

          public DocletTagWriter​(java.lang.String file,
                                 java.lang.String encode)
                          throws java.io.IOException

      Doclet のエントリポイントメソッドです。
      パラメータ:
        `file` - 出力ファイル名
        `encode` - エンコード
      例外:
        `java.io.IOException` - なんらかのエラーが発生した場合。

    - #### DocletTagWriter

          public DocletTagWriter​(java.lang.String file,
                                 java.lang.String encode,
                                 boolean r2b)
                          throws java.io.IOException

      Doclet のエントリポイントメソッドです。
      パラメータ:
        `file` - 出力ファイル名
        `encode` - エンコード
        `r2b` - 改行コードをBRタグに置換するかどうか [true:置換する/false:置換しない]
      例外:
        `java.io.IOException` - なんらかのエラーが発生した場合。

  - ### メソッドの詳細

    - #### close

          public void close()

      出力ファイルをクロースします。

    - #### printTag

          public void printTag​(java.lang.String... str)

      可変長の文字列引数を取り、文字列を出力します。 文字列の最後に改行が入ります。
      パラメータ:
        `str` - String...

    - #### printTag

          public void printTag​(com.sun.javadoc.Tag... tag)

      タグ配列を受け取り、タグ出力します。 従来は、Tagが、１つの場合と配列の場合で改行出力を分けていましたが、改行しないことにします。
      パラメータ:
        `tag` - タグ配列(可変長引数)

    - #### printTag

          public void printTag​(java.lang.String str1,
                               com.sun.javadoc.Tag[] tag,
                               java.lang.String str3)

      文字列引数を ２つと、タグ配列を受け取り、タグ出力します。
      パラメータ:
        `str1` - 第一文字列
        `tag` - タグ配列
        `str3` - 第三文字列

    - #### printCSVTag

          public void printCSVTag​(com.sun.javadoc.Tag... tag)

      タグ配列を受け取り、タグ出力します。 複数のタグを出力する場合に、CSV形式で連結します。
      パラメータ:
        `tag` - タグ配列(可変長引数)

    - #### printTagsInfo

          public void printTagsInfo​(com.sun.javadoc.Tag... tag)

      タグ配列を受け取り、タグ出力します。 ここでは、タグ毎にタグの名称と内容を出力し、改行を行います。 特殊処理：ここでは、og.rev タグは取り込みません。
      パラメータ:
        `tag` - タグ配列(可変長引数)

    - #### printChar

          public void printChar​(java.lang.String str1,
                                com.sun.javadoc.Tag[] tag,
                                java.lang.String str3)

      文字列引数を ２つと、タグ配列を受け取り、先頭一文字のタグ出力します。
      パラメータ:
        `str1` - 第一文字列
        `tag` - タグ配列
        `str3` - 第三文字列