com.neeve.cli.annotations
Annotation Type Configured


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

Marks a field or a method as configured by the X runtime.


Required Element Summary
 String property
          Returns the configuration property name.
 
Optional Element Summary
 String defaultValue
          The option's default value.
 String description
          Returns a description of the property.
 boolean required
          Indicates whether a configuration value is required.
 

Element Detail

property

public abstract String property
Returns the configuration property name.

For example: "java.vendor", etc

Returns:
The name of the property.

required

public abstract boolean required
Indicates whether a configuration value is required.

If no default is specified and no value is defined for the property then the configuration will fail.

Returns:
Whether or not the value is required to present in configuration.
Default:
false

defaultValue

public abstract String defaultValue
The option's default value. When the option is not specified the option will be set to this value.

Returns:
The option's default value
Default:
""

description

public abstract String description
Returns a description of the property.

Default:
""


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.