com.asakusafw.info

Class ParameterInfo

java.lang.Object

com.asakusafw.info.ParameterInfo

public class ParameterInfo
extends Object

Represents a batch parameter definition.

Since:

0.9.1

Constructor Summary

Constructors

Constructor and Description
ParameterInfo(String name, String comment, boolean mandatory, String pattern) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getComment() Returns the comment.
String	getName() Returns the name.
String	getPattern() Returns the parameter value pattern in regular expression.
int	hashCode()
boolean	isMandatory() Returns whether or not this parameter is mandatory.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterInfo

public ParameterInfo(String name,
                     String comment,
                     boolean mandatory,
                     String pattern)

Creates a new instance.

Parameters:

name - the parameter name

comment - the comment (nullable)

mandatory - true if this parameter is mandatory, otherwise false

pattern - the parameter value pattern in regular expression (nullable)

Method Detail

getName

public String getName()

Returns the name.

Returns:

the name

getComment

public String getComment()

Returns the comment.

Returns:

the comment, or null if it is not defined

isMandatory

public boolean isMandatory()

Returns whether or not this parameter is mandatory.

Returns:

true if this parameter is mandatory, otherwise false

getPattern

public String getPattern()

Returns the parameter value pattern in regular expression.

Returns:

the pattern, or null if it is not defined

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