public class DriverPropertyInfo extends Object
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.
Modifier and Type | Field | Description |
---|---|---|
String[] |
choices |
An array of possible values if the value for the field
DriverPropertyInfo.value may be selected
from a particular set of values; otherwise null. |
String |
description |
A brief description of the property, which may be null.
|
String |
name |
The name of the property.
|
boolean |
required |
The
required field is true if a value must be
supplied for this property
during Driver.connect and false otherwise. |
String |
value |
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. |
Constructor | Description |
---|---|
DriverPropertyInfo (String name,
String value) |
Constructs a
DriverPropertyInfo object with a given
name and value. |
public String name
public String description
public boolean required
required
field is true
if a value must be
supplied for this property
during Driver.connect
and false
otherwise.public String value
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.public String[] choices
DriverPropertyInfo.value
may be selected
from a particular set of values; otherwise null.public DriverPropertyInfo(String name, String value)
DriverPropertyInfo
object with a given
name and value. The description
and choices
are initialized to null
and required
is initialized
to false
.name
- the name of the propertyvalue
- the current value, which may be null Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.