Top Description Fields Constructors Methods
org.apache.derby.client.am

public Class FailedProperties40

extends Object
Class Inheritance
Imports
java.util.Properties, .Enumeration, .Map, .HashMap, java.sql.SQLClientInfoException, .ClientInfoStatus
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 java.sql.SQLClientInfoException See org.apache.derby.iapi.jdbc.FailedProperties40

Field Summary

Modifier and TypeField and Description
private final HashMap<String, ClientInfoStatus>
failedProps_

private final String
firstKey_

private final String
firstValue_

Constructor Summary

AccessConstructor and Description
public
FailedProperties40(Properties
a Properties value. Can be null or empty
props)

Creates a new FailedProperties40 instance.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a String value
getFirstKey()

getFirstKey returns the first property key.

public String

Returns:

a String value
getFirstValue()

getFirstValue returns the first property value.

public Map<String, ClientInfoStatus>

Returns:

a Map<String,ClientInfoStatus> object with the failed property keys and the reason why each failed
getProperties()

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

public static Properties

Returns:

the created Properties object
makeProperties(String
property key
name, String
property value
value)

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

failedProps_back to summary
private final HashMap<String, ClientInfoStatus> failedProps_
firstKey_back to summary
private final String firstKey_
firstValue_back to summary
private final String firstValue_

Constructor Detail

FailedProperties40back to summary
public FailedProperties40(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:Properties

a Properties value. Can be null or empty

Method Detail

getFirstKeyback to summary
public String getFirstKey()

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

Returns:String

a String value

getFirstValueback to summary
public String getFirstValue()

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

Returns:String

a String value

getPropertiesback to summary
public Map<String, ClientInfoStatus> getProperties()

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

Returns:Map<String, ClientInfoStatus>

a Map<String,ClientInfoStatus> object with the failed property keys and the reason why each failed

makePropertiesback to summary
public static Properties makeProperties(String name, String value)

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

Parameters
name:String

property key

value:String

property value

Returns:Properties

the created Properties object