Java Platform 1.2
Beta 4

Class java.sql.DriverPropertyInfo

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

public class DriverPropertyInfo
extends Object

The DriverPropertyInfo class is only of interest to advanced programmers who need to interact with a Driver via getDriverProperties to discover and supply properties for connections.


Field Summary
 String[] choices
          If the value may be selected from a particular set of values, then this is an array of the possible values.
 String description
          A brief description of the property.
 String name
          The name of the property.
 boolean required
          "required" is true if a value must be supplied for this property during Driver.connect.
 String value
          "value" specifies the current value of the property, based on a combination of the information supplied to getPropertyInfo, the Java environment, and driver supplied default values.
 
Constructor Summary
DriverPropertyInfo(String name, String value)
          Constructor a DriverPropertyInfo 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 String name
The name of the property.

description

public String description
A brief description of the property. This may be null.

required

public boolean required
"required" is true if a value must be supplied for this property during Driver.connect. Otherwise the property is optional.

value

public String value
"value" specifies the current value of the property, based on a combination of the information supplied to getPropertyInfo, the Java environment, and driver supplied default values. This may be null if no value is known.

choices

public String[] choices
If the value may be selected from a particular set of values, then this is an array of the possible values. Otherwise it should be null.
Constructor Detail

DriverPropertyInfo

public DriverPropertyInfo(String name,
                          String value)
Constructor a DriverPropertyInfo 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

Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.