Package oracle.jdbc.spi
Interface OracleResourceProvider.Parameter
-
- Enclosing interface:
- OracleResourceProvider
public static interface OracleResourceProvider.Parameter
A parameter that configures anOracleResourceProvider
. Instances ofParameter
may be queried by Oracle JDBC and database tools.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.lang.CharSequence
defaultValue()
Returns the default value of this parameter, if any.default java.lang.String
description()
Returns a human-readable description of this parameter.default boolean
isRequired()
Returnstrue
if configuring this parameter is required, orfalse
if it is optional.boolean
isSensitive()
Returnstrue
if this parameter may set to a security sensitive value, such as a password.java.lang.String
name()
Returns the name of this parameter.
-
-
-
Method Detail
-
name
java.lang.String name()
Returns the name of this parameter. Names are case-insensitive.- Returns:
- The name of this parameter. Not null.
-
isSensitive
boolean isSensitive()
Returnstrue
if this parameter may set to a security sensitive value, such as a password.- Returns:
true
if this parameter is security sensitive, orfalse
if not.
-
description
default java.lang.String description()
Returns a human-readable description of this parameter. This method is intended for database tools to display information about this parameter to a user.- Returns:
- A description of this parameter. Not null.
-
isRequired
default boolean isRequired()
Returnstrue
if configuring this parameter is required, orfalse
if it is optional.- Returns:
true
if this is a required parameter, orfalse
if not.
-
defaultValue
default java.lang.CharSequence defaultValue()
Returns the default value of this parameter, if any.- Returns:
- The default value of this parameter, or
null
if there is no default value.
-
-