DriverPropertyInfo

AI-generated Key Takeaways

• DriverPropertyInfo objects encapsulate information about properties needed to establish database connections.

• These properties are primarily used by advanced programmers for interaction with JDBC drivers.

• Key information includes property name, current value, a description, whether it's required, and potential value choices.

• Driver.connect uses these properties, and some may be mandatory for successful connection establishment.

• A constructor is provided to initialize DriverPropertyInfo with a name and initial value.

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

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.
public String	description	A brief description of the property, which may be null.
public String	name	The name of the property.
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.

Public Constructor Summary

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

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Fields

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.

public String description

A brief description of the property, which may be null.

public String name

The name of the property.

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 Constructors

public DriverPropertyInfo (String name, String 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