java.sql: public class: DriverPropertyInfo

java.sql
public class: DriverPropertyInfo [javadoc | source]

java.lang.Object
   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.
Field Summary
public String name The name of the property.
public String description A brief description of the property, which may be null.
public boolean required The required field is true if a value must be supplied for this property during Driver.connect and false otherwise.
public 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.
public 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:

public DriverPropertyInfo(String name, String value)
{ this.name = name; this.value = value; }
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 - the name of the property
value - the current value, which may be null

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Summary
public String	name	The name of the property.
public String	description	A brief description of the property, which may be null.
public boolean	required	The `required` field is `true` if a value must be supplied for this property during `Driver.connect` and `false` otherwise.
public 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.
public 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.