com.asakusafw.vocabulary.iterative

Annotation Type IterativeBatch

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface IterativeBatch

An annotation for iterative batch classes.

Since:

0.8.0

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DEFAULT_PARAMETER_VALUE_PATTERN The default parameter value pattern.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The identifier for the target batch (a.k.a. batch ID).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	comment The comments for the target batch.
IterativeBatch.Parameter[]	parameters The available batch arguments.
boolean	strict Whether this batch accepts only predefined batch arguments (in parameters()) or not.

Field Detail

DEFAULT_PARAMETER_VALUE_PATTERN

public static final String DEFAULT_PARAMETER_VALUE_PATTERN

The default parameter value pattern.

Element Detail

name

public abstract String name

The identifier for the target batch (a.k.a. batch ID). The batch ID must be unique in the system, and must be in the form of the following rule:

Name:
    SimpleName
    Name "." SimpleName
SimpleName:
    NameStart NamePart*
NameStart: one of
    A-Z
    a-z
    _
NamePart: one of
    NameStart
    0-9

In other words, the above rule is a subset of Java package names (e.g. com.asakusafw).

comment

public abstract String comment

The comments for the target batch.

Default:

""

parameters

public abstract IterativeBatch.Parameter[] parameters

The available batch arguments.

See Also:

strict()

Default:

{}

strict

public abstract boolean strict

Whether this batch accepts only predefined batch arguments (in parameters()) or not. false accepts any batch arguments even if they are not predefined.

Default:

false