DriverPropertyInfo
open class DriverPropertyInfo
kotlin.Any | |
↳ | java.sql.DriverPropertyInfo |
Driver properties for making a connection. The DriverPropertyInfo
class is of interest only to advanced programmers who need to interact with a Driver via the method getDriverProperties
to discover and supply properties for connections.
Summary
Public constructors | |
---|---|
DriverPropertyInfo(name: String!, value: String!) Constructs a |
Properties | |
---|---|
Array<String!>! |
An array of possible values if the value for the field |
String! |
A brief description of the property, which may be null. |
String! |
The name of the property. |
Boolean |
The |
String! |
The |
Public constructors
DriverPropertyInfo
DriverPropertyInfo(
name: String!,
value: String!)
Constructs a DriverPropertyInfo
object with a given name and value. The description
and choices
are intialized to null
and required
is initialized to false
.
Parameters | |
---|---|
name |
String!: the name of the property |
value |
String!: the current value, which may be null |
Properties
choices
var choices: Array<String!>!
An array of possible values if the value for the field DriverPropertyInfo.value
may be selected from a particular set of values; otherwise null.
description
var description: String!
A brief description of the property, which may be null.
required
var required: Boolean
The required
field is true
if a value must be supplied for this property during Driver.connect
and false
otherwise.
value
var value: String!
The value
field specifies the current value of the property, based on a combination of the information supplied to the method getPropertyInfo
, the Java environment, and the driver-supplied default values. This field may be null if no value is known.