public final class ConfigurationSetting extends Object
ConfigurationSetting
, specifying it's type, and default value.oracle.dbtools.plugin.api.conf
package descriptionModifier and Type | Class and Description |
---|---|
static class |
ConfigurationSetting.Builder
Builds
ConfigurationSetting instances |
Modifier and Type | Method and Description |
---|---|
Object |
defaultValue()
The default value for the setting
|
static boolean |
isConfigurationType(Class<?> type)
Indicates if the specifiec type is a supported
ConfigurationSetting type |
boolean |
isGlobal()
Indicates if this is a global level setting
|
boolean |
isSecure()
Indicates if this setting contains sensitive data that must be kept secure
|
ConfigurationSetting.Builder |
modify()
Produce a new
ConfigurationSetting.Builder instance initialized with the state of this ConfigurationSetting |
static ConfigurationSetting.Builder |
setting()
Create a
ConfigurationSetting.Builder instance |
static ConfigurationSetting |
setting(boolean defaultValue)
Define a
Boolean setting |
static <T extends Enum<T>> |
setting(Class<T> type, T defaultValue)
Define an
Enum setting |
static ConfigurationSetting |
setting(int defaultValue)
Define an
Integer property |
static ConfigurationSetting |
setting(long defaultValue)
Define a
Long setting |
static ConfigurationSetting |
setting(String defaultValue)
Define a
String property |
static ConfigurationSetting |
setting(TimeDuration defaultValue)
Define a
TimeDuration property |
String |
toString() |
Class<?> |
type()
The type of the setting
|
public Object defaultValue()
null
if the setting has no default valuepublic boolean isGlobal()
true
if this setting can only be configured for the entire application, false
otherwisepublic boolean isSecure()
public ConfigurationSetting.Builder modify()
ConfigurationSetting.Builder
instance initialized with the state of this ConfigurationSetting
ConfigurationSetting.Builder
instancepublic Class<?> type()
public static boolean isConfigurationType(Class<?> type)
ConfigurationSetting
typetype
- The type to checkpublic static ConfigurationSetting.Builder setting()
ConfigurationSetting.Builder
instanceConfigurationSetting.Builder
instancepublic static ConfigurationSetting setting(boolean defaultValue)
Boolean
settingdefaultValue
- The default value. For consistency the default value should always be false
ConfigurationSetting
instancepublic static <T extends Enum<T>> ConfigurationSetting setting(Class<T> type, T defaultValue)
Enum
settingT
- An Enum
sub-typetype
- The type of the Enum
subclassdefaultValue
- The default value.ConfigurationSetting
instancepublic static ConfigurationSetting setting(int defaultValue)
Integer
propertydefaultValue
- The default value.ConfigurationSetting
instancepublic static ConfigurationSetting setting(long defaultValue)
Long
settingdefaultValue
- The default value.ConfigurationSetting
instancepublic static ConfigurationSetting setting(String defaultValue)
String
propertydefaultValue
- The default value.ConfigurationSetting
instancepublic static ConfigurationSetting setting(TimeDuration defaultValue)
TimeDuration
propertydefaultValue
- The default valueConfigurationSetting
instance