org.opengion.hayabusa.taglib

## クラス CommentTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.opengion.hayabusa.taglib.CommonTagSupport
      - - org.opengion.hayabusa.taglib.CommentTag

- すべての実装されたインタフェース:
    java.io.Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally

      public class CommentTag
      extends CommonTagSupport

       JSPアプリケーションに対してバージョン管理できるようにコメントを
       記述するためのタグです。

       バージョン、ビルド番号、日付、変更者、タイトルなどを記述できます。
       変更内容は、text属性か、BODY 部に記述します。
       パラメーター変数({@XXXX})は、使用できません。

  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:comment title="･･･" version="･･･" date="･･･" author="･･･" ･･･ />
         ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)

         ●Tag定義：
           <og:comment
               rdcCode            【TAG】コメントの設計変更要求コードを設定します
               title            ○【TAG】コメントのタイトルを設定します(必須)。
               version          ○【TAG】コメントのバージョンを設定します(必須)。
               build              【TAG】コメントのビルド番号を設定します
               date             ○【TAG】コメントの変更日付を設定します(必須)。
               author           ○【TAG】コメントの変更者を設定します(必須)。
               text               【TAG】コメントの内容を設定します
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
               pgid               【TAG】コメントのプログラムIDを設定します
               system             【TAG】コメントのシステム名称を設定します
           >   ... Body ...
           </og:comment>

         ●使用例
             <og:comment
                 title   = "変更概要"
                 version = "001"
                 date    = "YYYY/MM/DD"
                 author  = "Y.MATSUI(Hybs) "
                 rdcCode = "RDC00001"
                 text    = "当処理中の変更内容を記述します。"
             />

             <og:comment
                 title   = "変更概要"
                 version = "001"
                 date    = "YYYY/MM/DD"
                 author  = "Y.MATSUI(Hybs) "
                 rdcCode = "RDC00001"
                 build   = "ビルド番号"           (必須属性では有りません。)
             >
               当処理中の変更内容を記述します。
             </og:comment>

  変更履歴:

    2.1.3.0 (2002/12/12) JSP画面の管理用に、画面に変更履歴を持たせる為のタグを新規作成
    3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

  機能分類
    画面部品
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

    - ### クラスから継承されたフィールド org.opengion.hayabusa.taglib.CommonTagSupport

      `BR, BUFFER_MIDDLE, CR`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.BodyTagSupport

      `bodyContent`

    - ### クラスから継承されたフィールド javax.servlet.jsp.tagext.TagSupport

      `id, pageContext`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.BodyTag

      `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.IterationTag

      `EVAL_BODY_AGAIN`

    - ### インタフェースから継承されたフィールド javax.servlet.jsp.tagext.Tag

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

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

    コンストラクタ
    コンストラクタと説明
    `CommentTag()` デフォルトコンストラクター

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doAfterBody()` Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setAuthor(java.lang.String val)` 【TAG】変更者を設定します。
    `void` | `setBuild(java.lang.String val)` 【TAG】ビルド番号を設定します。
    `void` | `setDate(java.lang.String val)` 【TAG】変更日付を設定します。
    `void` | `setPgid(java.lang.String val)` 【TAG】プログラムIDを指定します。
    `void` | `setRdcCode(java.lang.String val)` 【TAG】設計変更要求コードを設定します。
    `void` | `setSystem(java.lang.String val)` 【TAG】システム名称を設定します。
    `void` | `setText(java.lang.String val)` 【TAG】内容を設定します。
    `void` | `setTitle(java.lang.String val)` 【TAG】タイトルを設定します。
    `void` | `setVersion(java.lang.String val)` 【TAG】バージョンを設定します。
    `java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。

    - ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.CommonTagSupport

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doCatch, doEndTag, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, getTagName, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.BodyTagSupport

      `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

    - ### クラスから継承されたメソッド javax.servlet.jsp.tagext.TagSupport

      `findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

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

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

    - ### インタフェースから継承されたメソッド javax.servlet.jsp.tagext.Tag

      `getParent, setPageContext, setParent`

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

    - #### CommentTag

          public CommentTag()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
        `doStartTag` インタフェース内 `Tag`
      オーバーライド:
        `doStartTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:

        3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

    - #### doAfterBody

          public int doAfterBody()

      Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
      定義:
        `doAfterBody` インタフェース内 `IterationTag`
      オーバーライド:
        `doAfterBody` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示(SKIP_BODY)
      変更履歴:

        2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
        3.0.0.0 (2002/12/25) StringUtil#changeString 廃止
        3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。

    - #### release2

          protected void release2()

      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
        `release2` クラス内 `CommonTagSupport`
      変更履歴:

        2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
        3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
        3.3.2.0 (2003/07/07) 設計変更要求コード(rdcCode)属性を追加。
        3.8.9.3 (2007/08/31) PGID(pgid)、システム名称(system)属性を追加。

    - #### setRdcCode

          public void setRdcCode(java.lang.String val)

      【TAG】設計変更要求コードを設定します。
      パラメータ:
        `val` - 設計変更要求コード
      説明:

             コメントの設計変更要求コードを設定します。

      変更履歴:

        3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

    - #### setTitle

          public void setTitle(java.lang.String val)

      【TAG】タイトルを設定します。
      パラメータ:
        `val` - タイトル
      説明:

             コメントのタイトルを設定します。

      変更履歴:

        2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
        3.0.0.0 (2002/12/25) StringUtil#changeString 廃止
        3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

    - #### setVersion

          public void setVersion(java.lang.String val)

      【TAG】バージョンを設定します。
      パラメータ:
        `val` - バージョン
      説明:

             コメントのバージョンを設定します

      変更履歴:

        3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

    - #### setBuild

          public void setBuild(java.lang.String val)

      【TAG】ビルド番号を設定します。
      パラメータ:
        `val` - ビルド番号
      説明:

             コメントのビルド番号を設定します

      変更履歴:

        3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

    - #### setDate

          public void setDate(java.lang.String val)

      【TAG】変更日付を設定します。
      パラメータ:
        `val` - 変更日付
      説明:

             コメントの変更日付を設定します

      変更履歴:

        3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

    - #### setAuthor

          public void setAuthor(java.lang.String val)

      【TAG】変更者を設定します。
      パラメータ:
        `val` - 変更者
      説明:

             コメントの変更者を設定します

      変更履歴:

        3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

    - #### setText

          public void setText(java.lang.String val)

      【TAG】内容を設定します。
      パラメータ:
        `val` - コメントの内容
      説明:

             コメントの内容を設定します。
             ここでの内容は、BODY部に記述することも可能です。
             両方に記述した場合は、text属性を優先します。

      変更履歴:

        3.3.1.0 (2003/06/24) text 属性追加、パラメータ変数を使えないように変更。

    - #### setPgid

          public void setPgid(java.lang.String val)

      【TAG】プログラムIDを指定します。
      パラメータ:
        `val` - プログラムID
      説明:

             コメントのプログラムIDを設定します。

    - #### setSystem

          public void setSystem(java.lang.String val)

      【TAG】システム名称を設定します。
      パラメータ:
        `val` - システム名称
      説明:

             コメントのシステム名称を設定します。

    - #### toString

          public java.lang.String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `CommonTagSupport`
      戻り値:
        このクラスの文字列表現
      このメソッドは、nullを返しません

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