Package Summary  Overview Summary

class:DriverPropertyInfo [NONE]



  •                                                 
                                public class DriverPropertyInfo
    extends java.lang.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:name [NONE]

  • name

    public java.lang.String name
    The name of the property.

field:description [NONE]

  • description

    public java.lang.String description
    A brief description of the property, which may be null.

field:required [NONE]

  • required

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

field:value [NONE]

  • value

    public java.lang.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.

field:choices [NONE]

  • choices

    public java.lang.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.

constructor:DriverPropertyInfo(java.lang.String, java.lang.String) [NONE]

  • DriverPropertyInfo

    public DriverPropertyInfo(java.lang.String name,
                              java.lang.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 - the name of the property
    value - the current value, which may be null