org.seasar.extension.jdbc.gen.internal.meta
クラス CommentDoclet

java.lang.Object
  com.sun.javadoc.Doclet
      org.seasar.extension.jdbc.gen.internal.meta.CommentDoclet

public class CommentDoclet
extends com.sun.javadoc.Doclet

エンティティとプロパティのコメントを抽出するDocletです。

作成者:

taedium

コンストラクタの概要

CommentDoclet()

メソッドの概要

protected static void	doEntityComment(com.sun.javadoc.ClassDoc classDoc, EntityMeta entityMeta) エンティティクラスのコメントを処理します。
protected static void	doPropertyComment(com.sun.javadoc.FieldDoc fieldDoc, PropertyMeta propertyMeta) プロパティのコメントを処理します。
protected static java.util.Map<java.lang.String,com.sun.javadoc.FieldDoc>	getFieldDocMap(com.sun.javadoc.ClassDoc classDoc) フィールド名をキー、 FieldDocを値とするマップを返します。
protected static boolean	isMappedSuperclass(com.sun.javadoc.ClassDoc classDoc) MappedSuperclassを表す場合trueを返します。
static boolean	start(com.sun.javadoc.RootDoc rootDoc)

クラス com.sun.javadoc.Doclet から継承されたメソッド

languageVersion, optionLength, validOptions

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

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

コンストラクタの詳細

CommentDoclet

public CommentDoclet()

メソッドの詳細

start

public static boolean start(com.sun.javadoc.RootDoc rootDoc)

doEntityComment

protected static void doEntityComment(com.sun.javadoc.ClassDoc classDoc,
                                      EntityMeta entityMeta)

エンティティクラスのコメントを処理します。

パラメータ:

classDoc -

entityMeta - エンティティメタデータ

doPropertyComment

protected static void doPropertyComment(com.sun.javadoc.FieldDoc fieldDoc,
                                        PropertyMeta propertyMeta)

プロパティのコメントを処理します。

パラメータ:

fieldDoc -

propertyMeta - プロパティメタデータ

getFieldDocMap

protected static java.util.Map<java.lang.String,com.sun.javadoc.FieldDoc> getFieldDocMap(com.sun.javadoc.ClassDoc classDoc)

フィールド名をキー、 FieldDocを値とするマップを返します。

パラメータ:

classDoc -

戻り値:

フィールド名をキー、 FieldDocを値とするマップ

isMappedSuperclass

protected static boolean isMappedSuperclass(com.sun.javadoc.ClassDoc classDoc)

MappedSuperclassを表す場合trueを返します。

パラメータ:

classDoc -

戻り値:

MappedSuperclassを表す場合true