This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
java.sql
class DriverPropertyInfo
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 |
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 |
Constructs a DriverPropertyInfo object with a given
name and value.
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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.
description
public String description
-
A brief description of the property, which may be null.
name
public String name
-
The name of the property.
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.
DriverPropertyInfo
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
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.