org.apache.derby.client.am

Class FailedProperties40

java.lang.Object

org.apache.derby.client.am.FailedProperties40

public class FailedProperties40
extends java.lang.Object

Class FailedProperties40 is a helper class for java.sql.SQLClientInfoException. It provides convenient access to data that is needed when constructing those exceptions. Should be kept in sync with its embedded counter part.

See Also:

SQLClientInfoException, FailedProperties40

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.HashMap<java.lang.String,java.sql.ClientInfoStatus>	failedProps_
private java.lang.String	firstKey_
private java.lang.String	firstValue_

Constructor Summary

Constructors

Constructor and Description
FailedProperties40(java.util.Properties props) Creates a new FailedProperties40 instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFirstKey() getFirstKey returns the first property key.
java.lang.String	getFirstValue() getFirstValue returns the first property value.
java.util.Map<java.lang.String,java.sql.ClientInfoStatus>	getProperties() getProperties provides a Map object describing the failed properties (as specified in the javadoc for java.sql.SQLClientInfoException).
static java.util.Properties	makeProperties(java.lang.String name, java.lang.String value) Helper method that creates a Propery object with the name-value pair given as arguments.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

failedProps_

private final java.util.HashMap<java.lang.String,java.sql.ClientInfoStatus> failedProps_

firstKey_

private final java.lang.String firstKey_

firstValue_

private final java.lang.String firstValue_

Constructor Detail

FailedProperties40

public FailedProperties40(java.util.Properties props)

Creates a new FailedProperties40 instance. Since Derby doesn't support any properties, all the keys from the props parameter are added to the failedProps_ member with value REASON_UNKNOWN_PROPERTY.

Parameters:

props - a Properties value. Can be null or empty

Method Detail

makeProperties

public static java.util.Properties makeProperties(java.lang.String name,
                                  java.lang.String value)

Helper method that creates a Propery object with the name-value pair given as arguments.

Parameters:

name - property key

value - property value

Returns:

the created Properties object

getProperties

public java.util.Map<java.lang.String,java.sql.ClientInfoStatus> getProperties()

getProperties provides a Map object describing the failed properties (as specified in the javadoc for java.sql.SQLClientInfoException).

Returns:

a Map object with the failed property keys and the reason why each failed

getFirstKey

public java.lang.String getFirstKey()

getFirstKey returns the first property key. Used when SQLClientInfoException is thrown with a parameterized error message.

Returns:

a String value

getFirstValue

public java.lang.String getFirstValue()

getFirstValue returns the first property value. Used when SQLClientInfoException is thrown with a parameterized error message.

Returns:

a String value