org.dllearner.core.config
Annotation Type ConfigOption

@Retention(value=RUNTIME)
public @interface ConfigOption

Annotation for all DL-Learner configuration options.

Author:

Chris Shellenbarger, Jens Lehmann, Lorenz Bühmann

Required Element Summary

String	name The name of this config option.
Class<? extends PropertyEditor>	propertyEditorClass An implementation of the Property Editor to use

Optional Element Summary

String	defaultValue Returns the default value of this config option.
String	description The description of this config option
boolean	required Returns whether this option is required for initializing the component.

Element Detail

name

public abstract String name

The name of this config option.

Returns:

The name of this config option.

propertyEditorClass

public abstract Class<? extends PropertyEditor> propertyEditorClass

An implementation of the Property Editor to use

Returns:

description

public abstract String description

The description of this config option

Returns:

Default:

"no description available"

required

public abstract boolean required

Returns whether this option is required for initializing the component.

Returns:

True if the option is required and false otherwise.

Default:

false

defaultValue

public abstract String defaultValue

Returns the default value of this config option. Default values should be set for all optional values. It is an overhead to describe the default value both in the source code and in the annotation. There are two reasons for this: a) the value of the field cannot easily be accessed without creating an instance of the component and b) for more complex structures the default may only be created in the constructor or init method.

Returns:

The default value of this option.

Default:

""