APIdia Launch Partner
Top Description Fields Constructors Methods
java.sql

public Class DriverPropertyInfo

extends Object
Class Inheritance
Imports
java.util.Properties

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

Modifier and TypeField and Description
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.

Constructor Summary

AccessConstructor and Description
public
DriverPropertyInfo(String
the name of the property
name, String
the current value, which may be null
value)

Constructs a DriverPropertyInfo object with a given name and value.

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

choicesback to 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.

descriptionback to summary
public String description

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

nameback to summary
public String name

The name of the property.

requiredback to summary
public boolean required

The required field is true if a value must be supplied for this property during Driver.connect and false otherwise.

valueback to summary
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.

Constructor Detail

DriverPropertyInfoback to summary
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:String

the name of the property

value:String

the current value, which may be null