openGionopenGion
5.5.7.0

org.opengion.fukurou.taglet
クラス DocletTagWriter

java.lang.Object
  上位を拡張 org.opengion.fukurou.taglet.DocletTagWriter

public final class DocletTagWriter
extends java.lang.Object

Tag 情報を出力する PrintWriter 相当クラスです。

バージョン
4.0
作成者
Kazuhiko Hasegawa
導入されたバージョン:
JDK5.0,

フィールドの概要
static java.lang.String BR
          HTML上のブレーク <br> + CR
static java.lang.String CR
          リターンコード System.getProperty("line.separator")
 
コンストラクタの概要
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 のエントリポイントメソッドです。
 
メソッドの概要
 void close()
          出力ファイルをクロースします。
 void printChar(java.lang.String str1, com.sun.javadoc.Tag[] tag, java.lang.String str3)
          文字列引数を 2つと、タグ配列を受け取り、先頭一文字のタグ出力します。
 void printCSVTag(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)
          文字列引数を 2つと、タグ配列を受け取り、タグ出力します。
 void printTag(com.sun.javadoc.Tag[] tag)
          タグ配列を受け取り、タグ出力します。
 void printTagsInfo(com.sun.javadoc.Tag[] tag)
          タグ配列を受け取り、タグ出力します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

CR

public static final java.lang.String CR
リターンコード System.getProperty("line.separator")


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タグに置換するかどうか
例外:
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が、1つの場合と配列の場合で改行出力を分けていましたが、改行しないことにします。

パラメータ:
tag - タグ配列
変更履歴:
5.5.4.1 (2012/07/06) {@og.value package.class#field} の処理 対応
5.5.4.1 (2012/07/06) DocletUtil.htmlFilter → StringUtil.htmlFilter に変更
5.5.4.2 (2012/07/13) タグ出力の最後に改行を入れておきます。
5.5.5.6 (2012/08/31) @og.tag などに @og.value が含まれている場合の処理を追加

printCSVTag

public void printCSVTag(com.sun.javadoc.Tag[] tag)
タグ配列を受け取り、タグ出力します。 複数のタグを出力する場合に、カンマ区切り文字で連結します。

パラメータ:
tag - タグ配列
変更履歴:
5.5.4.1 (2012/07/06) DocletUtil.htmlFilter → StringUtil.htmlFilter に変更

printTagsInfo

public void printTagsInfo(com.sun.javadoc.Tag[] tag)
タグ配列を受け取り、タグ出力します。 ここでは、タグ毎にタグの名称と内容を出力し、改行を行います。 特殊処理:ここでは、og.rev タグは取り込みません。

パラメータ:
tag - タグ配列
変更履歴:
5.5.4.1 (2012/07/06) DocletUtil.htmlFilter → StringUtil.htmlFilter に変更

printTag

public void printTag(java.lang.String str1,
                     com.sun.javadoc.Tag[] tag,
                     java.lang.String str3)
文字列引数を 2つと、タグ配列を受け取り、タグ出力します。

パラメータ:
str1 - 第一文字列
tag - タグ配列
str3 - 第三文字列

printChar

public void printChar(java.lang.String str1,
                      com.sun.javadoc.Tag[] tag,
                      java.lang.String str3)
文字列引数を 2つと、タグ配列を受け取り、先頭一文字のタグ出力します。

パラメータ:
str1 - 第一文字列
tag - タグ配列
str3 - 第三文字列

openGion 5.5.7.0

Webアプリケーションフレームワーク openGion
SourceForge.JPCopyright (c) 2009 The openGion Project.