pexa.tool.ant.builder.base

クラス PEXABuilderTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MatchingTask

pexa.tool.ant.builder.base.PEXABuilderTask

すべての実装されたインタフェース:

java.lang.Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer, PEXABuilderContainer

public class PEXABuilderTask
extends org.apache.tools.ant.taskdefs.MatchingTask
implements PEXABuilderContainer

PEXAの成果物ビルダーのコンテナとなる、Antタスク実装です。

バージョン:

$Revision: 4730 $ $Date:: 2010-02-22 20:10:54 #$

作成者:

morishita

フィールドのサマリー

クラスから継承されたフィールド org.apache.tools.ant.taskdefs.MatchingTask

fileset

クラスから継承されたフィールド org.apache.tools.ant.Task

target, taskName, taskType, wrapper

クラスから継承されたフィールド org.apache.tools.ant.ProjectComponent

description, location, project

インタフェースから継承されたフィールド pexa.tool.ant.builder.PEXABuilderContainer

BUILD_TARGET_PROPERTY, BUILD_TARGET_XML, KEY_DestFile, KEY_TemplateFile

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
PEXABuilderTask()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addConfiguredFileSet(org.apache.tools.ant.types.FileSet f) filesetタグの内容を設定する
void	addConfiguredOutputSet(PEXABuilderOutputSet os) outputsetタグの内容を設定する
void	addConfiguredParameter(PEXABuilderParameter p) parameterタグの内容を設定する
void	error(java.lang.String message) エラーメッセージをコンソールログ出力する
void	error(java.lang.Throwable t) エラーメッセージをコンソールログ出力する
void	execute() ビルド処理を実行する
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() ビルドエラー発生時にビルドをストップするかを判定する
boolean	isPrintStackTrace() 予期しない例外が発生した場合にスタックトレースを表示するかを判定する。
void	output(java.util.Map source, java.util.Map outputInfo) 指定された内容でビルド対象を出力する
void	setBaseDir(java.io.File b) baseDir属性値を設定する
void	setBuilder(java.lang.String b) builder属性値を設定する
void	setCatalogDir(java.io.File c) catalogDir属性値を設定する
void	setFailOnError(boolean f) failOnError属性値を設定する
void	setName(java.lang.String n) name属性を設定する
void	setPrintStackTrance(boolean p) printStackTrance属性値を設定する
void	setTarget(java.lang.String t) target属性値を設定する

クラスから継承されたメソッド org.apache.tools.ant.taskdefs.MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

クラスから継承されたメソッド org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

クラスから継承されたメソッド org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation

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

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

コンストラクタの詳細

PEXABuilderTask

public PEXABuilderTask()

メソッドの詳細

setBaseDir

public void setBaseDir(java.io.File b)

baseDir属性値を設定する

パラメータ:

b -

setCatalogDir

public void setCatalogDir(java.io.File c)

catalogDir属性値を設定する

パラメータ:

c -

setBuilder

public void setBuilder(java.lang.String b)

builder属性値を設定する

パラメータ:

b -

setName

public void setName(java.lang.String n)

name属性を設定する

パラメータ:

n -

setTarget

public void setTarget(java.lang.String t)

target属性値を設定する

パラメータ:

t -

setFailOnError

public void setFailOnError(boolean f)

failOnError属性値を設定する

パラメータ:

f -

setPrintStackTrance

public void setPrintStackTrance(boolean p)

printStackTrance属性値を設定する

パラメータ:

p -

addConfiguredOutputSet

public void addConfiguredOutputSet(PEXABuilderOutputSet os)

outputsetタグの内容を設定する

パラメータ:

os -

addConfiguredParameter

public void addConfiguredParameter(PEXABuilderParameter p)

parameterタグの内容を設定する

パラメータ:

p -

addConfiguredFileSet

public void addConfiguredFileSet(org.apache.tools.ant.types.FileSet f)

filesetタグの内容を設定する

パラメータ:

f -

execute

public void execute()
             throws org.apache.tools.ant.BuildException

ビルド処理を実行する

オーバーライド:

execute クラス内 org.apache.tools.ant.Task

例外:

org.apache.tools.ant.BuildException

getBuildTargetType

public java.lang.String getBuildTargetType()

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

定義:

getBuildTargetType インタフェース内 PEXABuilderContainer

戻り値:

ビルド対象種別

getBuilderClassName

public java.lang.String getBuilderClassName()

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

定義:

getBuilderClassName インタフェース内 PEXABuilderContainer

戻り値:

ビルダ実装クラス名

getParameter

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

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

定義:

getParameter インタフェース内 PEXABuilderContainer

パラメータ:

key - パラメータキー

戻り値:

パラメータ値

getParameterMap

public java.util.Map getParameterMap()

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

定義:

getParameterMap インタフェース内 PEXABuilderContainer

戻り値:

パラメータマップ

getBuildTargetName

public java.lang.String getBuildTargetName()

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

定義:

getBuildTargetName インタフェース内 PEXABuilderContainer

戻り値:

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

getBuildTargets

public BuildTarget[] getBuildTargets()

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

定義:

getBuildTargets インタフェース内 PEXABuilderContainer

戻り値:

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

getBaseDir

public java.io.File getBaseDir()

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

定義:

getBaseDir インタフェース内 PEXABuilderContainer

戻り値:

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

getCatalogDir

public java.io.File getCatalogDir()

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

定義:

getCatalogDir インタフェース内 PEXABuilderContainer

戻り値:

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

output

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

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

定義:

output インタフェース内 PEXABuilderContainer

パラメータ:

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

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

例外:

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

isFailOnError

public boolean isFailOnError()

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

定義:

isFailOnError インタフェース内 PEXABuilderContainer

戻り値:

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

isPrintStackTrace

public boolean isPrintStackTrace()

予期しない例外が発生した場合にスタックトレースを表示するかを判定する。

戻り値:

スタックトレースを表示するならtrue、しないならfalse

info

public void info(java.lang.String message)

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

定義:

info インタフェース内 PEXABuilderContainer

パラメータ:

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

error

public void error(java.lang.String message)

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

定義:

error インタフェース内 PEXABuilderContainer

パラメータ:

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

error

public void error(java.lang.Throwable t)

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

定義:

error インタフェース内 PEXABuilderContainer

パラメータ:

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