Class OptionSetting
- All Implemented Interfaces:
Serializable
,Cloneable
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The allowed values of the option setting.The DB engine specific parameter type.The data type of the option setting.The default value of the option setting.The description of the option setting.Indicates if the option setting is part of a collection.A Boolean value that, when true, indicates the option setting can be modified from the default.getName()
The name of the option that has settings that you can set.getValue()
The current value of the option setting.int
hashCode()
Indicates if the option setting is part of a collection.A Boolean value that, when true, indicates the option setting can be modified from the default.void
setAllowedValues
(String allowedValues) The allowed values of the option setting.void
setApplyType
(String applyType) The DB engine specific parameter type.void
setDataType
(String dataType) The data type of the option setting.void
setDefaultValue
(String defaultValue) The default value of the option setting.void
setDescription
(String description) The description of the option setting.void
setIsCollection
(Boolean isCollection) Indicates if the option setting is part of a collection.void
setIsModifiable
(Boolean isModifiable) A Boolean value that, when true, indicates the option setting can be modified from the default.void
The name of the option that has settings that you can set.void
The current value of the option setting.toString()
Returns a string representation of this object; useful for testing and debugging.withAllowedValues
(String allowedValues) The allowed values of the option setting.withApplyType
(String applyType) The DB engine specific parameter type.withDataType
(String dataType) The data type of the option setting.withDefaultValue
(String defaultValue) The default value of the option setting.withDescription
(String description) The description of the option setting.withIsCollection
(Boolean isCollection) Indicates if the option setting is part of a collection.withIsModifiable
(Boolean isModifiable) A Boolean value that, when true, indicates the option setting can be modified from the default.The name of the option that has settings that you can set.The current value of the option setting.
-
Constructor Details
-
OptionSetting
public OptionSetting()
-
-
Method Details
-
setName
The name of the option that has settings that you can set.
- Parameters:
name
- The name of the option that has settings that you can set.
-
getName
The name of the option that has settings that you can set.
- Returns:
- The name of the option that has settings that you can set.
-
withName
The name of the option that has settings that you can set.
- Parameters:
name
- The name of the option that has settings that you can set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setValue
The current value of the option setting.
- Parameters:
value
- The current value of the option setting.
-
getValue
The current value of the option setting.
- Returns:
- The current value of the option setting.
-
withValue
The current value of the option setting.
- Parameters:
value
- The current value of the option setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultValue
The default value of the option setting.
- Parameters:
defaultValue
- The default value of the option setting.
-
getDefaultValue
The default value of the option setting.
- Returns:
- The default value of the option setting.
-
withDefaultValue
The default value of the option setting.
- Parameters:
defaultValue
- The default value of the option setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
The description of the option setting.
- Parameters:
description
- The description of the option setting.
-
getDescription
The description of the option setting.
- Returns:
- The description of the option setting.
-
withDescription
The description of the option setting.
- Parameters:
description
- The description of the option setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setApplyType
The DB engine specific parameter type.
- Parameters:
applyType
- The DB engine specific parameter type.
-
getApplyType
The DB engine specific parameter type.
- Returns:
- The DB engine specific parameter type.
-
withApplyType
The DB engine specific parameter type.
- Parameters:
applyType
- The DB engine specific parameter type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDataType
The data type of the option setting.
- Parameters:
dataType
- The data type of the option setting.
-
getDataType
The data type of the option setting.
- Returns:
- The data type of the option setting.
-
withDataType
The data type of the option setting.
- Parameters:
dataType
- The data type of the option setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAllowedValues
The allowed values of the option setting.
- Parameters:
allowedValues
- The allowed values of the option setting.
-
getAllowedValues
The allowed values of the option setting.
- Returns:
- The allowed values of the option setting.
-
withAllowedValues
The allowed values of the option setting.
- Parameters:
allowedValues
- The allowed values of the option setting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIsModifiable
A Boolean value that, when true, indicates the option setting can be modified from the default.
- Parameters:
isModifiable
- A Boolean value that, when true, indicates the option setting can be modified from the default.
-
getIsModifiable
A Boolean value that, when true, indicates the option setting can be modified from the default.
- Returns:
- A Boolean value that, when true, indicates the option setting can be modified from the default.
-
withIsModifiable
A Boolean value that, when true, indicates the option setting can be modified from the default.
- Parameters:
isModifiable
- A Boolean value that, when true, indicates the option setting can be modified from the default.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isModifiable
A Boolean value that, when true, indicates the option setting can be modified from the default.
- Returns:
- A Boolean value that, when true, indicates the option setting can be modified from the default.
-
setIsCollection
Indicates if the option setting is part of a collection.
- Parameters:
isCollection
- Indicates if the option setting is part of a collection.
-
getIsCollection
Indicates if the option setting is part of a collection.
- Returns:
- Indicates if the option setting is part of a collection.
-
withIsCollection
Indicates if the option setting is part of a collection.
- Parameters:
isCollection
- Indicates if the option setting is part of a collection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isCollection
Indicates if the option setting is part of a collection.
- Returns:
- Indicates if the option setting is part of a collection.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-