com.asakusafw.windgate.core

Class DriverScript

java.lang.Object

com.asakusafw.windgate.core.DriverScript

public class DriverScript
extends Object

A script describes drivers' behavior.

Since:

0.2.2

Version:

0.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DriverScript.Kind Driver kind (source / drain).

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX_DRAIN Prefix of property keys about drain drivers.
static String	PREFIX_SOURCE Prefix of property keys about source drivers.

Constructor Summary

Constructors

Constructor and Description
DriverScript(String resource, Map<String,String> configuration) Creates a new instance.
DriverScript(String resource, Map<String,String> configuration, Set<String> parameterNames) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getConfiguration() Returns the configuration for this driver.
Set<String>	getParameterNames() Returns the required parameter names.
String	getResourceName() Returns the name of target resource.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_SOURCE

public static final String PREFIX_SOURCE

Prefix of property keys about source drivers.

See Also:

Constant Field Values

PREFIX_DRAIN

public static final String PREFIX_DRAIN

Prefix of property keys about drain drivers.

See Also:

Constant Field Values

Constructor Detail

DriverScript

public DriverScript(String resource,
                    Map<String,String> configuration)

Creates a new instance.

Parameters:

resource - the name of target resource

configuration - configurations for this driver

Throws:

IllegalArgumentException - if any parameter is null

DriverScript

public DriverScript(String resource,
                    Map<String,String> configuration,
                    Set<String> parameterNames)

Creates a new instance.

Parameters:

resource - the name of target resource

configuration - configurations for this driver

parameterNames - required parameter names

Throws:

IllegalArgumentException - if any parameter is null

Since:

0.8.0

Method Detail

getResourceName

public String getResourceName()

Returns the name of target resource. This represents a resource name defined in profile.

Returns:

the resource name

getConfiguration

public Map<String,String> getConfiguration()

Returns the configuration for this driver.

Returns:

the configuration

getParameterNames

public Set<String> getParameterNames()

Returns the required parameter names.

Returns:

the required parameter names

Since:

0.8.0