pexa.tool.ant.builder

インタフェース PEXABuilderContainer

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

PEXABuilderTask

public interface PEXABuilderContainer

PEXAの成果物ビルダーのコンテナを表すインタフェースです。 成果物に応じたBuilderPluginの呼出元でもあり、BuilderPluginへの引数にもなります。

バージョン:

$Revision: 2615 $ $Date:: 2008-10-31 16:09:29 #$

作成者:

morishita

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	BUILD_TARGET_PROPERTY ビルド対象種別(Property)
static java.lang.String	BUILD_TARGET_XML ビルド対象種別(XML)
static java.lang.String	KEY_DestFile outputメソッドコール時のoutputInfoに格納するパラメータのキー(出力ファイル)
static java.lang.String	KEY_TemplateFile outputメソッドコール時のoutputInfoに格納するパラメータのキー(テンプレートファイル)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	error(java.lang.String message) エラーメッセージをコンソールログ出力する
void	error(java.lang.Throwable t) エラーメッセージをコンソールログ出力する
java.io.File	getBaseDir() ビルド実行時のベースディレクトリを取得する
java.lang.String	getBuilderClassName() Builderの実装クラス名を取得します。
java.lang.String	getBuildTargetName() ビルド対象を表す名称を取得します。
BuildTarget[]	getBuildTargets() ビルド対象を表すSourceオブジェクトの配列を取得します。
java.lang.String	getBuildTargetType() ビルド対象のタイプを取得します。
java.io.File	getCatalogDir() カタログファイルのベースディレクトリを取得する
java.lang.String	getParameter(java.lang.String key) build.xmlで指定される任意のパラメータを取得します。
java.util.Map	getParameterMap() build.xmlで指定される任意のパラメータの格納マップを取得します。
void	info(java.lang.String message) ログメッセージをコンソールログ出力する
boolean	isFailOnError() ビルドエラー発生時にビルドをストップするかを判定する
void	output(java.util.Map source, java.util.Map outputInfo) 指定された内容でビルド対象を出力する

フィールドの詳細

KEY_DestFile

static final java.lang.String KEY_DestFile

outputメソッドコール時のoutputInfoに格納するパラメータのキー(出力ファイル)

関連項目:

定数フィールド値

KEY_TemplateFile

static final java.lang.String KEY_TemplateFile

outputメソッドコール時のoutputInfoに格納するパラメータのキー(テンプレートファイル)

関連項目:

定数フィールド値

BUILD_TARGET_XML

static final java.lang.String BUILD_TARGET_XML

ビルド対象種別(XML)

関連項目:

定数フィールド値

BUILD_TARGET_PROPERTY

static final java.lang.String BUILD_TARGET_PROPERTY

ビルド対象種別(Property)

関連項目:

定数フィールド値

メソッドの詳細

getBuildTargetType

java.lang.String getBuildTargetType()

ビルド対象のタイプを取得します。

戻り値:

ビルド対象種別

getBuilderClassName

java.lang.String getBuilderClassName()

Builderの実装クラス名を取得します。

戻り値:

ビルダ実装クラス名

getParameter

java.lang.String getParameter(java.lang.String key)

build.xmlで指定される任意のパラメータを取得します。

パラメータ:

key - パラメータキー

戻り値:

パラメータ値

getParameterMap

java.util.Map getParameterMap()

build.xmlで指定される任意のパラメータの格納マップを取得します。

戻り値:

パラメータマップ

getBuildTargetName

java.lang.String getBuildTargetName()

ビルド対象を表す名称を取得します。ログ出力用。

戻り値:

ビルド対象を表す名称の文字列

getBuildTargets

BuildTarget[] getBuildTargets()

ビルド対象を表すSourceオブジェクトの配列を取得します。

戻り値:

ビルド対象オブジェクトの配列

getBaseDir

java.io.File getBaseDir()

ビルド実行時のベースディレクトリを取得する

戻り値:

ベースディレクトリ。指定がない場合はnull。

getCatalogDir

java.io.File getCatalogDir()

カタログファイルのベースディレクトリを取得する

戻り値:

ベースディレクトリ。指定がない場合はnull。

output

void output(java.util.Map source,
            java.util.Map outputInfo)
     throws PEXABuilderException

指定された内容でビルド対象を出力する

パラメータ:

source - 出力内容を格納したマップ。基本的にはテンプレートに対するパラメータの格納マップとなる。

outputInfo - 出力パラメータ情報マップ。出力ファイル名などが格納される。

例外:

PEXABuilderException - テンプレート適用もしくはファイル出力の失敗

isFailOnError

boolean isFailOnError()

ビルドエラー発生時にビルドをストップするかを判定する

戻り値:

エラー発生時にビルドを止めるならtrue、とめないならfalse

info

void info(java.lang.String message)

ログメッセージをコンソールログ出力する

パラメータ:

message - ログ出力したいメッセージ

error

void error(java.lang.String message)

エラーメッセージをコンソールログ出力する

パラメータ:

message - ログ出力したいメッセージ

error

void error(java.lang.Throwable t)

エラーメッセージをコンソールログ出力する

パラメータ:

t - ログ出力したい例外オブジェクト