com.asakusafw.yaess.core

Class CommandScript

java.lang.Object

com.asakusafw.yaess.core.CommandScript

All Implemented Interfaces:

ExecutionScript

public class CommandScript
extends Object
implements ExecutionScript

A script that describes process command using operating system shell.

Since:

0.2.3

Version:

0.8.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.asakusafw.yaess.core.ExecutionScript

ExecutionScript.Kind, ExecutionScript.PlaceholderResolver

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PROFILE_NAME Default profile name (empty string).

Fields inherited from interface com.asakusafw.yaess.core.ExecutionScript

ENV_ASAKUSA_HOME, PLACEHOLDER_ARGUMENTS, PLACEHOLDER_EXECUTION_ID, PLACEHOLDER_HOME

Constructor Summary

Constructors

Constructor and Description
CommandScript(String id, Set<String> blockerIds, String profileName, String moduleName, List<String> command, Map<String,String> environmentVariables) Creates a new instance.
CommandScript(String id, Set<String> blockerIds, String profileName, String moduleName, List<String> command, Map<String,String> environmentVariables, Collection<String> supportedExtensions) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<String>	getBlockerIds() Returns the IDs representing blockers of this script execution.
List<String>	getCommandLineTokens() Returns a sequence of command line tokens.
Map<String,String>	getEnvironmentVariables() Returns desired environment variables used in this execution.
String	getId() Returns the ID of this script execution.
ExecutionScript.Kind	getKind() Returns the kind of this script.
String	getModuleName() Returns a module name of target command.
String	getProfileName() Returns the profile name to execute this command.
Set<String>	getSupportedExtensions() Returns the supported extension names.
int	hashCode()
boolean	isResolved() Returns whether this script is resolved.
CommandScript	resolve(ExecutionContext context, ExecutionScriptHandler<?> handler) Resolves placeholders defined in this script.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROFILE_NAME

public static final String DEFAULT_PROFILE_NAME

Default profile name (empty string).

See Also:

Constant Field Values

Constructor Detail

CommandScript

public CommandScript(String id,
                     Set<String> blockerIds,
                     String profileName,
                     String moduleName,
                     List<String> command,
                     Map<String,String> environmentVariables)

Creates a new instance. Note that this creates an UNRESOLVED instance. To create a resolved instance, please use resolve(ExecutionContext, ExecutionScriptHandler).

Parameters:

id - the script ID

blockerIds - other script IDs blocking this script execution

profileName - the profile name to execute this command, empty string means use default profile

moduleName - module name of target command

command - sequence of command tokens

environmentVariables - the extra environment variables

Throws:

IllegalArgumentException - if some parameters were null

See Also:

DEFAULT_PROFILE_NAME, resolve(ExecutionContext, ExecutionScriptHandler)

CommandScript

public CommandScript(String id,
                     Set<String> blockerIds,
                     String profileName,
                     String moduleName,
                     List<String> command,
                     Map<String,String> environmentVariables,
                     Collection<String> supportedExtensions)

Creates a new instance. Note that this creates an UNRESOLVED instance. To create a resolved instance, please use resolve(ExecutionContext, ExecutionScriptHandler).

Parameters:

id - the script ID

blockerIds - other script IDs blocking this script execution

profileName - the profile name to execute this command, empty string means use default profile

moduleName - module name of target command

command - sequence of command tokens

environmentVariables - the extra environment variables

supportedExtensions - the supported extension names

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.8.0

See Also:

DEFAULT_PROFILE_NAME, resolve(ExecutionContext, ExecutionScriptHandler)

Method Detail

getKind

public ExecutionScript.Kind getKind()

Description copied from interface: ExecutionScript

Returns the kind of this script.

Specified by:

getKind in interface ExecutionScript

Returns:

the kind of this script

getId

public String getId()

Description copied from interface: ExecutionScript

Returns the ID of this script execution.

Specified by:

getId in interface ExecutionScript

Returns:

the ID of this script execution

getBlockerIds

public Set<String> getBlockerIds()

Description copied from interface: ExecutionScript

Returns the IDs representing blockers of this script execution.

Specified by:

getBlockerIds in interface ExecutionScript

Returns:

blockers' ID

getProfileName

public String getProfileName()

Returns the profile name to execute this command.

Returns:

the profile name, or an empty string to profile is unspecified

See Also:

DEFAULT_PROFILE_NAME

getModuleName

public String getModuleName()

Returns a module name of target command.

Returns:

the module name

getCommandLineTokens

public List<String> getCommandLineTokens()

Returns a sequence of command line tokens. If this script is not resolved, returning tokens may include some placeholders.

Returns:

the command line tokens

getEnvironmentVariables

public Map<String,String> getEnvironmentVariables()

Description copied from interface: ExecutionScript

Returns desired environment variables used in this execution.

Specified by:

getEnvironmentVariables in interface ExecutionScript

Returns:

desired environment variables

getSupportedExtensions

public Set<String> getSupportedExtensions()

Description copied from interface: ExecutionScript

Returns the supported extension names.

Specified by:

getSupportedExtensions in interface ExecutionScript

Returns:

the supported extension names

isResolved

public boolean isResolved()

Description copied from interface: ExecutionScript

Returns whether this script is resolved.

Specified by:

isResolved in interface ExecutionScript

Returns:

true for resolved instance, otherwise false

See Also:

ExecutionScript.resolve(ExecutionContext, ExecutionScriptHandler)

resolve

public CommandScript resolve(ExecutionContext context,
                             ExecutionScriptHandler<?> handler)
                      throws InterruptedException,
                             IOException

Description copied from interface: ExecutionScript

Resolves placeholders defined in this script. This method does not change this object, but returns a resolved object.

Specified by:

resolve in interface ExecutionScript

Parameters:

context - current context

handler - target handler

Returns:

resolved object

Throws:

InterruptedException - if interrupted while resolving this object

IOException - if failed to resolve some entry

See Also:

ExecutionScript.isResolved()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object