Class DriverPropertyInfo

java.lang.Object

java.sql.DriverPropertyInfo

public class DriverPropertyInfo
extends Object

Driver properties for making a connection. The DriverPropertyInfo class is of interest only to advanced programmers. The method Driver.getPropertyInfo(String, Properties) may be used to discover Driver properties.

Since:

1.1

Field Summary

Fields

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 Summary

Constructors

Constructor	Description
DriverPropertyInfo(String name, String value)	Constructs a DriverPropertyInfo object with a given name and value.

Method Summary

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Field Details

name

public String name

The name of the property.

description

public 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 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 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 Details

DriverPropertyInfo

public DriverPropertyInfo(String name,
 String value)

Constructs a DriverPropertyInfo object with a given name and value. The description and choices are initialized to null and required is initialized to false.

Parameters:

name - the name of the property

value - the current value, which may be null