java.sql
Class DriverPropertyInfo

java.lang.Object
  |
  +--java.sql.DriverPropertyInfo

public class DriverPropertyInfo
extends java.lang.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.


Field Summary
 java.lang.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.
 java.lang.String description
          A brief description of the property, which may be null.
 java.lang.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.
 java.lang.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 Summary
DriverPropertyInfo(java.lang.String name, java.lang.String value)
          Constructs a DriverPropertyInfo object with a name and value; other members default to their initial values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

public java.lang.String name
The name of the property.


description

public java.lang.String description
A brief description of the property, which may be null.


required

public boolean required
The required field is true if a value must be supplied for this property during Driver.connect and false otherwise.


value

public java.lang.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. This field may be null if no value is known.


choices

public java.lang.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.

Constructor Detail

DriverPropertyInfo

public DriverPropertyInfo(java.lang.String name,
                          java.lang.String value)
Constructs a DriverPropertyInfo object with a name and value; other members default to their initial values.

Parameters:
name - the name of the property
value - the current value, which may be null