nablarch.core.util.annotation

Annotation Type Published

@Target(value={TYPE,FIELD,CONSTRUCTOR,METHOD,ANNOTATION_TYPE})
 @Documented
 @Retention(value=RUNTIME)
public @interface Published

Nablarchが後方互換性を維持するAPIであることを表すアノテーション。

Nablarchが後方互換性を維持するAPIのことを公開APIと呼ぶ。
本アノテーションを付けたAPIは、javadocにより仕様が公開される。
本アノテーションをクラス宣言に付けた場合は、クラスのpublicなメンバが全て公開APIとなる。
特定のメソッドのみを公開APIとする場合は、本アノテーションをメソッド宣言に付ける。

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	tag 対象となる読者を識別する用途に使用するタグ（複数指定可）。 例えば、アーキテクト向けに公開したい場合は、 @Published(tag = "architect")というようにタグを付与する。 カスタムドックレットでAPIドキュメント生成時に、 出力対象タグを明示的に指定することで、 そのタグを持つAPIのみを公開することができる。 この際、タグが指定されていないAPIも出力対象となる。 つまり、タグが指定されていない公開APIと"architect"タグが指定された公開APIが出力される。

Element Detail

tag

public abstract java.lang.String[] tag

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

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

Default:

""