Skip to content

Most visited

Recently visited

navigation

DriverPropertyInfo

public class DriverPropertyInfo
extends Object

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.

Summary

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.

Public constructors

DriverPropertyInfo(String name, String value)

Constructs a DriverPropertyInfo object with a given name and value.

Inherited methods

From class java.lang.Object

Fields

choices

Added in API level 1
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.

description

Added in API level 1
String description

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

name

Added in API level 1
String name

The name of the property.

required

Added in API level 1
boolean required

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

value

Added in API level 1
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

DriverPropertyInfo

Added in API level 1
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 String: the name of the property
value String: the current value, which may be null
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.