V
- the value type for the optionpublic final class BaseOption<V> extends Object implements OptionMetadata<V>
OptionMetadata
,
OptionStorage
Constructor and Description |
---|
BaseOption(Class<V> clazz,
String identifier,
V defaultValue,
String name)
Created an instance of BaseOption using name as description
|
BaseOption(Class<V> clazz,
String identifier,
V defaultValue,
String name,
String description)
Created an instance of BaseOption of all the the given parameters
|
Modifier and Type | Method and Description |
---|---|
V |
defaultValue()
The default value for the option.
|
String |
description()
Widely describes the option purpose, intended to be used in UI.
|
String |
identifer()
The option identifier to use as a key to access the option value.
|
String |
name()
Briefly describes the option purpose, intended to be used in UI.
|
Class<V> |
valueClass()
The type of option value needed to perform type checks.
|
public BaseOption(Class<V> clazz, String identifier, V defaultValue, String name)
clazz
- the value type of the option, must not be null
identifier
- the identifier of the option, must not be null
defaultValue
- the default value of the option, must not be null
name
- the name of the option, must not be null
BaseOption(Class, String, Object, String, String)
public BaseOption(Class<V> clazz, String identifier, V defaultValue, String name, String description)
clazz
- the value type of the option, must not be null
identifier
- the identifier of the option, must not be null
defaultValue
- the default value of the option, must not be null
name
- the name of the option, must not be null
description
- the description of the option, must not be null
BaseOption(Class, String, Object, String)
public String identifer()
OptionMetadata
null
.identifer
in interface OptionMetadata<V>
public V defaultValue()
OptionMetadata
null
.defaultValue
in interface OptionMetadata<V>
public String name()
OptionMetadata
null
and should be localized. Should not be blank.name
in interface OptionMetadata<V>
public String description()
OptionMetadata
null
and should be localized. May be blank.description
in interface OptionMetadata<V>
public Class<V> valueClass()
OptionMetadata
null
.valueClass
in interface OptionMetadata<V>
Copyright (c) IBM Corp. and others 2004, 2020. All Rights Reserved.