java.sql

Class DriverPropertyInfo

java.lang.Object

java.sql.DriverPropertyInfo

public class DriverPropertyInfo
extends Object

A class holding information about driver properties of a database connection. This class is returned by the Driver.getPropertyInfo(String, java.util.Properties) method and allows for the advanced connection handling.

Field Summary

Fields

Modifier and Type	Field and Description
String[]	choices If the value member can be chosen from a set of possible values, they are contained here.
String	description A description of the property.
String	name The name of the property.
boolean	required true when the value member must be provided during Driver.connect.
String	value The current value associated with this property.

Constructor Summary

Constructors

Constructor and Description
DriverPropertyInfo(String name, String value) Creates a DriverPropertyInfo instance with the supplied name and value.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

choices

public String[] choices

If the value member can be chosen from a set of possible values, they are contained here. Otherwise choices is null.

description

public String description

A description of the property. May be null.

name

public String name

The name of the property.

required

public boolean required

true when the value member must be provided during Driver.connect. false otherwise.

value

public String value

The current value associated with this property. It is depending on the data gathered by the getPropertyInfo method, the general Java environment and the driver's default values.

Constructor Detail

DriverPropertyInfo

public DriverPropertyInfo(String name,
                          String value)

Creates a DriverPropertyInfo instance with the supplied name and value. Other class members take their default values.

Parameters:

name - The property name.

value - The property value.