lightbulb_outline Please take our October 2018 developer survey. Start survey
added in API level 1

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

Fields

choices

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

description

added in API level 1
public String description

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

name

added in API level 1
public String name

The name of the property.

required

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

DriverPropertyInfo

added in API level 1
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 String: the name of the property

value String: the current value, which may be null