pexa.tool.ejb

インタフェース Writer

既知の実装クラスのリスト:

AbstractVelocityWriterImpl, EjbCompileInfoWriterImpl, EjbJarWriterImpl, VendorDdWriterImpl

public interface Writer

EJB Docletより生成するファイルに応じたWriterクラスが 実装すべきインタフェース

バージョン:

$Revision: 457 $, $Date:: 2007-03-19 23:10:47 #$

作成者:

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	APSERVER オプション名(Aplication Serverの指定。
static java.lang.String	APSERVER_HOME オプション名(Aplication Serverのホームディレクトリ指定。
static java.lang.String	EJBJAR_DTD オプション名(ejb-jar.xmlのDTDパス指定)
static java.lang.String	SHORT_ENV_NAME オプション名(envファイル名の自動作成時に、パッケージ名を含めない名称にする)
static java.lang.String	TEMPLATEPATH オプション名(Velocity templateの格納ディレクトリ。
static java.lang.String	VENDER_DTD オプション名(Vender毎のDDファイルのDTDパス指定)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	init(java.util.Map param) Writerの初期化を行う
void	write(com.sun.javadoc.RootDoc root, com.sun.javadoc.ClassDoc classDoc) クラスを読み込み、ファイルを出力する

フィールドの詳細

TEMPLATEPATH

static final java.lang.String TEMPLATEPATH

オプション名(Velocity templateの格納ディレクトリ。必須)

関連項目:

定数フィールド値

APSERVER

static final java.lang.String APSERVER

オプション名(Aplication Serverの指定。省略時はDDファイルを作成しない)

関連項目:

定数フィールド値

APSERVER_HOME

static final java.lang.String APSERVER_HOME

オプション名(Aplication Serverのホームディレクトリ指定。 指定してあればDDファイルのDTDをローカルから取得するように設定される。 省略時はDTDのURLをベンダのサイトからネット経由で取得するように設定される)

関連項目:

定数フィールド値

EJBJAR_DTD

static final java.lang.String EJBJAR_DTD

オプション名(ejb-jar.xmlのDTDパス指定)

関連項目:

定数フィールド値

VENDER_DTD

static final java.lang.String VENDER_DTD

オプション名(Vender毎のDDファイルのDTDパス指定)

関連項目:

定数フィールド値

SHORT_ENV_NAME

static final java.lang.String SHORT_ENV_NAME

オプション名(envファイル名の自動作成時に、パッケージ名を含めない名称にする)

関連項目:

定数フィールド値

メソッドの詳細

init

void init(java.util.Map param)

Writerの初期化を行う

パラメータ:

param - パラメータを格納したMap

write

void write(com.sun.javadoc.RootDoc root,
           com.sun.javadoc.ClassDoc classDoc)
    throws WriteException,
           WriteFatalException

クラスを読み込み、ファイルを出力する

パラメータ:

classDoc - 読み込むクラスの情報

例外:

WriteException - 処理を続行できるエラー発生

WriteFatalException - 処理を中断しなければならないエラー発生