com.asakusafw.yaess.core

Class BatchScript

java.lang.Object

com.asakusafw.yaess.core.BatchScript

public class BatchScript
extends Object

A script describes each batch structure.

Since:

0.2.3

Version:

0.4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ID A configuration key name of IDs.
static String	KEY_VERIFICATION_CODE A configuration key name of verification code.
static String	KEY_VERSION A configuration key name of script version.
static String	VERSION Current version.

Constructor Summary

Constructors

Constructor and Description
BatchScript(String id, Collection<FlowScript> flows) Creates a new instance.
BatchScript(String batchId, String buildId, Collection<FlowScript> flows) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
FlowScript	findFlow(String flowId) Returns a FlowScript which has the specified flow ID.
List<FlowScript>	getAllFlows() Returns all FlowScripts defined in this batch.
String	getBuildId() Returns the build ID of this batch.
String	getId() Returns the ID of this batch.
static BatchScript	load(Properties properties) Loads a BatchScript.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_ID

public static final String KEY_ID

A configuration key name of IDs.

See Also:

Constant Field Values

KEY_VERSION

public static final String KEY_VERSION

A configuration key name of script version.

See Also:

Constant Field Values

KEY_VERIFICATION_CODE

public static final String KEY_VERIFICATION_CODE

A configuration key name of verification code.

See Also:

Constant Field Values

VERSION

public static final String VERSION

Current version.

See Also:

Constant Field Values

Constructor Detail

BatchScript

public BatchScript(String id,
                   Collection<FlowScript> flows)

Creates a new instance.

Parameters:

id - ID of this batch

flows - member flows

Throws:

IllegalArgumentException - if some parameters were null

BatchScript

public BatchScript(String batchId,
                   String buildId,
                   Collection<FlowScript> flows)

Creates a new instance.

Parameters:

batchId - ID of this batch

buildId - the application verification code, or null if not defined

flows - member flows

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.4.0

Method Detail

getId

public String getId()

Returns the ID of this batch.

Returns:

the batch ID

getBuildId

public String getBuildId()

Returns the build ID of this batch.

Returns:

the build ID, or null if not defined

findFlow

public FlowScript findFlow(String flowId)

Returns a FlowScript which has the specified flow ID.

Parameters:

flowId - target flow ID

Returns:

the related FlowScript, or null if not found

Throws:

IllegalArgumentException - if some parameters were null

getAllFlows

public List<FlowScript> getAllFlows()

Returns all FlowScripts defined in this batch.

Returns:

FlowScripts

load

public static BatchScript load(Properties properties)

Loads a BatchScript.

Parameters:

properties - source properties

Returns:

the loaded script

Throws:

IllegalArgumentException - if script is invalid, or some parameters were null