org.opengion.fukurou.taglet

## クラス AbstractTaglet

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

- すべての実装されたインタフェース:
    com.sun.tools.doclets.Taglet
  直系の既知のサブクラス:
    TagletDoc03Link, TagletFormSample, TagletRev, TagletTag, TagletValue

      public abstract class AbstractTaglet
      extends Object
      implements com.sun.tools.doclets.Taglet

       ソースコメントから、Javadoc を作成する場合のカスタムタグ情報を作成する
       Taglet インターフェースのAbstract 実装クラスを作成します。
       デフォルトの タグレットとしての初期値を設定します。
       つまり、isInlineTag() のみ false を返すメソッドを定義してあります。

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

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected static int` | `BUFFER_MIDDLE` StringBilderなどの初期値を設定します。

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `AbstractTaglet()`

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `inConstructor()` このタグレットがコンストラクタドキュメンテーションで 使用されている場合、true を返します。
    `boolean` | `inField()` このタグレットがフィールドドキュメンテーションで 使用されている場合、true を返します。
    `boolean` | `inMethod()` このタグレットがメソッドドキュメンテーションで 使用されている場合、true を返します。
    `boolean` | `inOverview()` このタグレットが概要ドキュメンテーションで 使用されている場合、true を返します。
    `boolean` | `inPackage()` このタグレットがパッケージドキュメンテーションで 使用されている場合、true を返します。
    `boolean` | `inType()` このタグレットがタイプドキュメンテーションで 使用されている場合、true を返します。
    `boolean` | `isInlineTag()` このタグレットがインラインタグで 使用されている場合、true を返します。
    `protected String` | `text(com.sun.javadoc.Tag tag)` このタグレットが各種インラインタグを処理するように用意された、 カスタムメソッドです。

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

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

    - ### インタフェースから継承されたメソッド com.sun.tools.doclets.Taglet

      `getName, toString, toString`

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

    - #### BUFFER_MIDDLE

          protected static final int BUFFER_MIDDLE

      StringBilderなどの初期値を設定します。 200
      関連項目:
        定数フィールド値

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

    - #### AbstractTaglet

          public AbstractTaglet()

  - ### メソッドの詳細

    - #### inField

          public boolean inField()

      このタグレットがフィールドドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。
      定義:
        `inField` インタフェース内 `com.sun.tools.doclets.Taglet`
      戻り値:
        フィールドドキュメンテーションの場合は true、そうでない場合は false を返します

    - #### inConstructor

          public boolean inConstructor()

      このタグレットがコンストラクタドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。
      定義:
        `inConstructor` インタフェース内 `com.sun.tools.doclets.Taglet`
      戻り値:
        コンストラクタドキュメンテーションの場合は true、そうでない場合は false を返します

    - #### inMethod

          public boolean inMethod()

      このタグレットがメソッドドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。
      定義:
        `inMethod` インタフェース内 `com.sun.tools.doclets.Taglet`
      戻り値:
        メソッドドキュメンテーションの場合は true、そうでない場合は false を返します

    - #### inOverview

          public boolean inOverview()

      このタグレットが概要ドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。
      定義:
        `inOverview` インタフェース内 `com.sun.tools.doclets.Taglet`
      戻り値:
        概要ドキュメンテーションの場合は true、そうでない場合は false を返します

    - #### inPackage

          public boolean inPackage()

      このタグレットがパッケージドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。
      定義:
        `inPackage` インタフェース内 `com.sun.tools.doclets.Taglet`
      戻り値:
        パッケージドキュメンテーションの場合は true、そうでない場合は false を返します

    - #### inType

          public boolean inType()

      このタグレットがタイプドキュメンテーションで 使用されている場合、true を返します。 インラインタグについては false が設定されます。
      定義:
        `inType` インタフェース内 `com.sun.tools.doclets.Taglet`
      戻り値:
        タイプドキュメンテーションの場合は true、そうでない場合は false を返します

    - #### isInlineTag

          public boolean isInlineTag()

      このタグレットがインラインタグで 使用されている場合、true を返します。 そうでない場合については false が設定されます。
      定義:
        `isInlineTag` インタフェース内 `com.sun.tools.doclets.Taglet`
      戻り値:
        インラインタグの場合は true、そうでない場合は false を返します

    - #### text

          protected String text(com.sun.javadoc.Tag tag)

      このタグレットが各種インラインタグを処理するように用意された、 カスタムメソッドです。 現時点では、{@link XXXX YYYY} 、{@og.value package.class#field}、 {@og.doc03Link queryType Query_**** クラス} を処理できます。
      パラメータ:
        `tag` - Tagオブジェクト
      戻り値:
        インラインタグ を処理した結果の文字列
      変更履歴:

        6.0.2.0 (2014/09/19) 新規追加

      このメソッドは、nullを返しません

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