org.jboss.soa.esb.configure
Annotation Type ConfigProperty


@Documented
@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface ConfigProperty

Configuration property class member annotation.

Author:
tom.fennelly@gmail.com
See Also:
Configurator

Optional Element Summary
 java.lang.String[] choice
          Paramater choice values.
 java.lang.String defaultVal
          The default paramater value.
 java.lang.String name
          The paramater name as defined in the resource configuration.
 ConfigProperty.Use use
          Paramater required or optional.
 

name

public abstract java.lang.String name
The paramater name as defined in the resource configuration. If not defined, the name defaults to the name of the field.

Returns:
The paramater name.
Default:
"##NULL##"

use

public abstract ConfigProperty.Use use
Paramater required or optional.

Defaults to required.

Returns:
Paramater usage.
Default:
org.jboss.soa.esb.configure.ConfigProperty.Use.REQUIRED

defaultVal

public abstract java.lang.String defaultVal
The default paramater value.

Only relevant when use=OPTIONAL and the paramater is not defined on the configuration..

Returns:
The default paramater value (un-decoded).
Default:
"##UNASSIGNED##"

choice

public abstract java.lang.String[] choice
Paramater choice values.

Returns:
List of valid choices (un-decoded).
Default:
"##NULL##"