Package nablarch.core.util.annotation

Annotation Interface Published

@Target({TYPE,FIELD,CONSTRUCTOR,METHOD,ANNOTATION_TYPE}) @Documented @Retention(RUNTIME) public @interface Published
Nablarchが後方互換性を維持するAPIであることを表すアノテーション。

Nablarchが後方互換性を維持するAPI（メソッドやフィールドを含む）のことを公開APIと呼ぶ。
本アノテーションを付けたAPIは、Javadocにより仕様を公開する。
クラスの全てのAPIを公開APIとする場合は、本アノテーションをクラス宣言に付与している。
特定のAPIを公開APIとする場合は、本アノテーションを対象のAPI宣言に付与している。
また、利用者がオーバーライド可能なメソッドも公開APIとし、本アノテーションを付与している。
公開APIのオーバーライドを行う場合は、Javadocに記述された仕様に則り実装を行うこと。

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    tag
    対象となる読者を識別する用途に使用するタグ（複数指定可）。

  • Element Details

    • tag

      String[] tag
      対象となる読者を識別する用途に使用するタグ（複数指定可）。

      例えば、アーキテクト向けに公開したい場合は、 @Published(tag = "architect")というようにタグを付与する。
      カスタムドックレットでAPIドキュメント生成時に、 出力対象タグを明示的に指定することで、 そのタグを持つAPIのみを公開することができる。
      この際、タグが指定されていないAPIも出力対象となる。 つまり、タグが指定されていない公開APIと"architect"タグが指定された公開APIが出力される。

      Default:
      {""}