net.aavalla.utils.jobpool.parameters
Annotation Type FieldAnnotations


@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface FieldAnnotations

Author:
Lari Natri

Optional Element Summary
 java.lang.String description
          Parameter description
 boolean internal
          True, if parameter is 'internal' ie doesn't require user input
 int lines
          Line count, only used with String fields
 java.lang.String name
          Name of the parameter
 boolean optional
          Set to true, if parameter is optional
 java.lang.Class<? extends ParameterValidator> validator
          Validator for the field
 java.lang.String[] validatorSettings
          Settings for the validator
 

name

public abstract java.lang.String name
Name of the parameter

Default:
"Unknown"

description

public abstract java.lang.String description
Parameter description

Default:
"Description not available"

internal

public abstract boolean internal
True, if parameter is 'internal' ie doesn't require user input

Default:
false

optional

public abstract boolean optional
Set to true, if parameter is optional

Default:
false

validator

public abstract java.lang.Class<? extends ParameterValidator> validator
Validator for the field

Default:
net.aavalla.utils.jobpool.parameters.validators.DefaultValidator.class

validatorSettings

public abstract java.lang.String[] validatorSettings
Settings for the validator

Default:
"$$$[NULL]$$$_represents_null"

lines

public abstract int lines
Line count, only used with String fields

Default:
1