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

# クラス DocTreeWriter

java.lang.Object
org.opengion.fukurou.taglet.DocTreeWriter

すべての実装されたインタフェース:
  `AutoCloseable`

public final class DocTreeWriter extends Object implements AutoCloseable
DocTree 情報を出力する PrintWriter 相当クラスです。

導入されたバージョン:
  JDK11.0,

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

  コンストラクタ
  コンストラクタ
  説明
  `DocTreeWriter(String file, String encode)`
  Doclet のエントリポイントメソッドです。

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `void`
  `close()`
  try-with-resourcesブロックで、自動的に呼ばれる AutoCloseable の実装。
  `(package private) String`
  `convertToOiginal(String unicode)`
  Unicode文字列から元の文字列に変換する ("￥u3042" → "あ")。
  `void`
  `printTag(String... str)`
  可変長の文字列引数を取り、文字列を出力します。
  `void`
  `printTag(String str1, List<? extends DocTree> doc, String str3)`
  文字列引数を ２つと、タグ配列を受け取り、タグ出力します。
  `void`
  `setClassName(String str)`
  現在処理中のクラス名をセットします。

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

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

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

  - ### DocTreeWriter

    public DocTreeWriter(String file, String encode) throws IOException
    Doclet のエントリポイントメソッドです。
    パラメータ:
      `file` - 出力ファイル名
      `encode` - エンコード
    例外:
      `IOException` - なんらかのエラーが発生した場合。
    変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応

- ## メソッドの詳細

  - ### close

    public void close()
    try-with-resourcesブロックで、自動的に呼ばれる AutoCloseable の実装。 コンストラクタで渡された ResultSet を close() します。
    定義:
      `close` インタフェース内 `AutoCloseable`
    関連項目:
      - `AutoCloseable.close()`
    変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応

  - ### setClassName

    public void setClassName(String str)
    現在処理中のクラス名をセットします。 これは、og.value の値所得時の自身のクラス名を求める場合に使用します。
    パラメータ:
      `str` - 現在処理中のクラス名
    変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応

  - ### printTag

    public void printTag(String... str)
    可変長の文字列引数を取り、文字列を出力します。 文字列の最後に改行が入ります。
    パラメータ:
      `str` - String...
    変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応

  - ### printTag

    public void printTag(String str1, List<? extends DocTree> doc, String str3)
    文字列引数を ２つと、タグ配列を受け取り、タグ出力します。
    パラメータ:
      `str1` - 第一文字列
      `doc` - DocTreeリスト
      `str3` - 第三文字列
    変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応, 8.0.0.0 (2021/07/31) Avoid instantiating new objects inside loops

  - ### convertToOiginal

    String convertToOiginal(String unicode)
    Unicode文字列から元の文字列に変換する ("￥u3042" → "あ")。
    パラメータ:
      `unicode` - Unicode文字列("あ")
    戻り値:
      通常の文字列
    変更履歴:
      7.3.0.0 (2021/01/06) 新しいJavaDoc対応