com.asakusafw.yaess.core

Class FlowScript

java.lang.Object

com.asakusafw.yaess.core.FlowScript

public final class FlowScript
extends Object

A script describes each jobflow structure.

Since:

0.2.3

Version:

0.8.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_BLOCKERS A configuration key name of blockers' ID.
static String	KEY_CLASS_NAME A configuration key name of class name.
static String	KEY_ENABLED_SCRIPT_KINDS A configuration key name of enabled script kinds.
static String	KEY_ENV_PREFIX The configuration key prefix of environment variables.
static String	KEY_FLOW_PREFIX A configuration key prefix of each flow.
static String	KEY_ID A configuration key name of IDs.
static String	KEY_KIND A configuration key name of script kind.
static String	KEY_MODULE A configuration key name of module name.
static String	KEY_PROFILE A configuration key name of profile name.
static String	KEY_SUPPORTED_EXTENSIONS A configuration key name of supported extensions.

Constructor Summary

Constructors

Constructor and Description
FlowScript(String id, Set<String> blockerIds, Map<ExecutionPhase,? extends Collection<? extends ExecutionScript>> scripts) Deprecated. Use FlowScript(String, Set, Map, Set) instead
FlowScript(String id, Set<String> blockerIds, Map<ExecutionPhase,? extends Collection<? extends ExecutionScript>> scripts, Set<ExecutionScript.Kind> enables) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Set<String>	extractFlowIds(Properties properties) Returns all flow IDs defined in the properties.
Set<String>	getBlockerIds() Returns the ID of this flow execution.
Set<ExecutionScript.Kind>	getEnabledScriptKinds() Returns the enabled script kinds in this flow execution.
String	getId() Returns the ID of this flow.
Map<ExecutionPhase,Set<ExecutionScript>>	getScripts() Returns the execution scripts for each ExecutionPhase.
int	hashCode()
static FlowScript	load(Properties properties, String flowId) Loads a FlowScript with the specified ID.
static Set<ExecutionScript>	load(Properties properties, String flowId, ExecutionPhase phase) Loads a ExecutionScripts in the specified flow and phase.
void	storeTo(Properties properties) Stores this script into the specified object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY_FLOW_PREFIX

public static final String KEY_FLOW_PREFIX

A configuration key prefix of each flow.

See Also:

Constant Field Values

KEY_ID

public static final String KEY_ID

A configuration key name of IDs.

See Also:

Constant Field Values

KEY_BLOCKERS

public static final String KEY_BLOCKERS

A configuration key name of blockers' ID.

See Also:

Constant Field Values

KEY_KIND

public static final String KEY_KIND

A configuration key name of script kind.

See Also:

Constant Field Values

KEY_CLASS_NAME

public static final String KEY_CLASS_NAME

A configuration key name of class name.

See Also:

Constant Field Values

KEY_PROFILE

public static final String KEY_PROFILE

A configuration key name of profile name.

See Also:

Constant Field Values

KEY_MODULE

public static final String KEY_MODULE

A configuration key name of module name.

See Also:

Constant Field Values

KEY_SUPPORTED_EXTENSIONS

public static final String KEY_SUPPORTED_EXTENSIONS

A configuration key name of supported extensions.

Since:

0.8.0

See Also:

Constant Field Values

KEY_ENABLED_SCRIPT_KINDS

public static final String KEY_ENABLED_SCRIPT_KINDS

A configuration key name of enabled script kinds.

Since:

0.8.0

See Also:

Constant Field Values

KEY_ENV_PREFIX

public static final String KEY_ENV_PREFIX

The configuration key prefix of environment variables.

See Also:

Constant Field Values

Constructor Detail

FlowScript

@Deprecated
public FlowScript(String id,
                              Set<String> blockerIds,
                              Map<ExecutionPhase,? extends Collection<? extends ExecutionScript>> scripts)

Deprecated. Use FlowScript(String, Set, Map, Set) instead

Creates a new instance.

Parameters:

id - the flow ID

blockerIds - the predecessors' flow ID

scripts - the execution scripts for each ExecutionPhase

Throws:

IllegalArgumentException - if some parameters were null

FlowScript

public FlowScript(String id,
                  Set<String> blockerIds,
                  Map<ExecutionPhase,? extends Collection<? extends ExecutionScript>> scripts,
                  Set<ExecutionScript.Kind> enables)

Creates a new instance.

Parameters:

id - the flow ID

blockerIds - the predecessors' flow ID

scripts - the execution scripts for each ExecutionPhase

enables - the enabled script kinds

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.8.0

Method Detail

getId

public String getId()

Returns the ID of this flow.

Returns:

the flow ID

getBlockerIds

public Set<String> getBlockerIds()

Returns the ID of this flow execution.

Returns:

the ID of this flow execution

getEnabledScriptKinds

public Set<ExecutionScript.Kind> getEnabledScriptKinds()

Returns the enabled script kinds in this flow execution.

Returns:

the enabled script kinds

Since:

0.8.0

getScripts

public Map<ExecutionPhase,Set<ExecutionScript>> getScripts()

Returns the execution scripts for each ExecutionPhase. If some phase has no scripts, then the related entry contains an empty list.

Returns:

the execution scripts

load

public static FlowScript load(Properties properties,
                              String flowId)

Loads a FlowScript with the specified ID.

Parameters:

properties - source properties

flowId - the target flow ID

Returns:

the loaded script

Throws:

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

See Also:

extractFlowIds(Properties)

load

public static Set<ExecutionScript> load(Properties properties,
                                        String flowId,
                                        ExecutionPhase phase)

Loads a ExecutionScripts in the specified flow and phase. If the target phase is empty in the specified flow, this returns an empty list. Note that this method will raise an exception if the specified flow does not exist.

Parameters:

properties - source properties

flowId - the target flow ID

phase - the target phase

Returns:

the loaded execution scripts

Throws:

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

See Also:

extractFlowIds(Properties)

extractFlowIds

public static Set<String> extractFlowIds(Properties properties)

Returns all flow IDs defined in the properties.

Parameters:

properties - target properties

Returns:

all flow IDs

Throws:

IllegalArgumentException - if some parameters were null

storeTo

public void storeTo(Properties properties)

Stores this script into the specified object.

Parameters:

properties - target properties

Throws:

IllegalArgumentException - if some parameters were null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object