# Print output for @column tags ?>
  public
  
  
  
  class
  SQLClientInfoException
  
  
  
  
  
  
  
  
  
  
    extends SQLException
  
  
  
  
  
  
| java.lang.Object | ||||
| ↳ | java.lang.Throwable | |||
| ↳ | java.lang.Exception | |||
| ↳ | java.sql.SQLException | |||
| ↳ | java.sql.SQLClientInfoException | |||
The subclass of SQLException is thrown when one or more client info properties
 could not be set on a Connection.  In addition to the information provided
 by SQLException, a SQLClientInfoException provides a list of client info
 properties that were not set.
 Some databases do not allow multiple client info properties to be set
 atomically.  For those databases, it is possible that some of the client
 info properties had been set even though the Connection.setClientInfo
 method threw an exception.  An application can use the getFailedProperties 
 method to retrieve a list of client info properties that were not set.  The
 properties are identified by passing a
 Map<String,ClientInfoStatus> to
 the appropriate SQLClientInfoException constructor.
 
| Public constructors | |
|---|---|
| 
      SQLClientInfoException()
      Constructs a  | |
| 
      SQLClientInfoException(Map<String, ClientInfoStatus> failedProperties)
      Constructs a  | |
| 
      SQLClientInfoException(Map<String, ClientInfoStatus> failedProperties, Throwable cause)
      Constructs a  | |
| 
      SQLClientInfoException(String reason, Map<String, ClientInfoStatus> failedProperties)
      Constructs a  | |
| 
      SQLClientInfoException(String reason, Map<String, ClientInfoStatus> failedProperties, Throwable cause)
      Constructs a  | |
| 
      SQLClientInfoException(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties)
      Constructs a  | |
| 
      SQLClientInfoException(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties, Throwable cause)
      Constructs a  | |
| 
      SQLClientInfoException(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties)
      Constructs a  | |
| 
      SQLClientInfoException(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties, Throwable cause)
      Constructs a  | |
| Public methods | |
|---|---|
| 
        
        
        
        
        
        Map<String, ClientInfoStatus> | 
      getFailedProperties()
      Returns the list of client info properties that could not be set. | 
| Inherited methods | |
|---|---|
public SQLClientInfoException ()
Constructs a SQLClientInfoException  Object.
 The reason,
 SQLState, and failedProperties list are initialized to
  null and the vendor code is initialized to 0.
 The cause is not initialized, and may subsequently be
 initialized by a call to the
 Throwable#initCause(java.lang.Throwable) method.
 
public SQLClientInfoException (Map<String, ClientInfoStatus> failedProperties)
Constructs a SQLClientInfoException object initialized with a
 given failedProperties.
 The reason and SQLState are initialized
 to null and the vendor code is initialized to 0.
 The cause is not initialized, and may subsequently be
 initialized by a call to the
 Throwable#initCause(java.lang.Throwable) method.
 
| Parameters | |
|---|---|
| failedProperties | Map: A Map containing the property values that could not
                                  be set.  The keys in the Map
                                  contain the names of the client info
                                  properties that could not be set and
                                  the values contain one of the reason codes
                                  defined inClientInfoStatus | 
public SQLClientInfoException (Map<String, ClientInfoStatus> failedProperties, Throwable cause)
Constructs a SQLClientInfoException object initialized with
 a given cause and failedProperties.
 The reason  is initialized to null if
 cause==null or to cause.toString() if
 cause!=null and the vendor code is initialized to 0.
 
| Parameters | |
|---|---|
| failedProperties | Map: A Map containing the property values that could not
                                  be set.  The keys in the Map
                                  contain the names of the client info
                                  properties that could not be set and
                                  the values contain one of the reason codes
                                  defined inClientInfoStatus | 
| cause | Throwable: the (which is saved for later retrieval by thegetCause()method); may be null indicating
     the cause is non-existent or unknown. | 
public SQLClientInfoException (String reason, Map<String, ClientInfoStatus> failedProperties)
Constructs a SQLClientInfoException object initialized with a
 given reason and failedProperties.
 The SQLState is initialized
 to null and the vendor code is initialized to 0.
 The cause is not initialized, and may subsequently be
 initialized by a call to the
 Throwable#initCause(java.lang.Throwable) method.
 
| Parameters | |
|---|---|
| reason | String: a description of the exception | 
| failedProperties | Map: A Map containing the property values that could not
                                  be set.  The keys in the Map
                                  contain the names of the client info
                                  properties that could not be set and
                                  the values contain one of the reason codes
                                  defined inClientInfoStatus | 
public SQLClientInfoException (String reason, Map<String, ClientInfoStatus> failedProperties, Throwable cause)
Constructs a SQLClientInfoException object initialized with a
 given reason, cause and
 failedProperties.
 The  SQLState is initialized
 to null and the vendor code is initialized to 0.
 
| Parameters | |
|---|---|
| reason | String: a description of the exception | 
| failedProperties | Map: A Map containing the property values that could not
                                  be set.  The keys in the Map
                                  contain the names of the client info
                                  properties that could not be set and
                                  the values contain one of the reason codes
                                  defined inClientInfoStatus | 
| cause | Throwable: the underlying reason for thisSQLException(which is saved for later retrieval by thegetCause()method); may be null indicating
     the cause is non-existent or unknown. | 
public SQLClientInfoException (String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties)
Constructs a SQLClientInfoException object initialized with a
 given  reason, SQLState  and
 failedProperties.
 The cause is not initialized, and may subsequently be
 initialized by a call to the
 Throwable#initCause(java.lang.Throwable) method. The vendor code
 is initialized to 0.
 
| Parameters | |
|---|---|
| reason | String: a description of the exception | 
| SQLState | String: an XOPEN or SQL:2003 code identifying the exception | 
| failedProperties | Map: A Map containing the property values that could not
                                  be set.  The keys in the Map
                                  contain the names of the client info
                                  properties that could not be set and
                                  the values contain one of the reason codes
                                  defined inClientInfoStatus | 
public SQLClientInfoException (String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties, Throwable cause)
Constructs a SQLClientInfoException object initialized with a
 given  reason, SQLState, cause
 and failedProperties.  The vendor code is initialized to 0.
 
| Parameters | |
|---|---|
| reason | String: a description of the exception | 
| SQLState | String: an XOPEN or SQL:2003 code identifying the exception | 
| failedProperties | Map: A Map containing the property values that could not
                                  be set.  The keys in the Map
                                  contain the names of the client info
                                  properties that could not be set and
                                  the values contain one of the reason codes
                                  defined inClientInfoStatus | 
| cause | Throwable: the underlying reason for thisSQLException(which is saved for later retrieval by thegetCause()method); may be null indicating
     the cause is non-existent or unknown. | 
public SQLClientInfoException (String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties)
Constructs a SQLClientInfoException object initialized with a
 given  reason, SQLState,
 vendorCode  and failedProperties.
 The cause is not initialized, and may subsequently be
 initialized by a call to the
 Throwable#initCause(java.lang.Throwable) method.
 
| Parameters | |
|---|---|
| reason | String: a description of the exception | 
| SQLState | String: an XOPEN or SQL:2003 code identifying the exception | 
| vendorCode | int: a database vendor-specific exception code | 
| failedProperties | Map: A Map containing the property values that could not
                                  be set.  The keys in the Map
                                  contain the names of the client info
                                  properties that could not be set and
                                  the values contain one of the reason codes
                                  defined inClientInfoStatus | 
public SQLClientInfoException (String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties, Throwable cause)
Constructs a SQLClientInfoException object initialized with a
 given  reason, SQLState,
 cause, vendorCode and
 failedProperties.
 
| Parameters | |
|---|---|
| reason | String: a description of the exception | 
| SQLState | String: an XOPEN or SQL:2003 code identifying the exception | 
| vendorCode | int: a database vendor-specific exception code | 
| failedProperties | Map: A Map containing the property values that could not
                                  be set.  The keys in the Map
                                  contain the names of the client info
                                  properties that could not be set and
                                  the values contain one of the reason codes
                                  defined inClientInfoStatus | 
| cause | Throwable: the underlying reason for thisSQLException(which is saved for later retrieval by thegetCause()method); may be null indicating
     the cause is non-existent or unknown. | 
public Map<String, ClientInfoStatus> getFailedProperties ()
Returns the list of client info properties that could not be set.  The
 keys in the Map  contain the names of the client info
 properties that could not be set and the values contain one of the
 reason codes defined in ClientInfoStatus
 
| Returns | |
|---|---|
| Map<String, ClientInfoStatus> | Map list containing the client info properties that could not be set |