com.pingidentity.pa.sdk.http

Class ExchangeProperty<T>

java.lang.Object

com.pingidentity.pa.sdk.http.ExchangeProperty<T>

Type Parameters:

T - the type of the value keyed off of this ExchangeProperty

public final class ExchangeProperty<T>
extends Object

A strongly-typed key that can be used to get and set properties of an Exchange.

Instances of this class are created via the static create(String, String, Class) method.

See Also:

Exchange.getProperty(ExchangeProperty), Exchange.getRequiredProperty(ExchangeProperty), Exchange.setProperty(ExchangeProperty, Object)

Method Summary

Modifier and Type	Method and Description
static <T> ExchangeProperty<T>	create(String namespace, String identifier, Class<T> type) Creates a new ExchangeProperty.
boolean	equals(Object o) Indicates whether some other object is "equal to" this property.
String	getIdentifier()
String	getKey() Retrieves a unique key for this property, which is a concatenation of the namespace and identifier, in the form:
String	getNamespace()
Class<T>	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getNamespace

public String getNamespace()

Returns:

the property namespace

getIdentifier

public String getIdentifier()

Returns:

the property identifier

getType

public Class<T> getType()

Returns:

the value type for this property

getKey

public String getKey()

Retrieves a unique key for this property, which is a concatenation of the namespace and identifier, in the form:

 [namespace]:[identifier]
 

Returns:

the property key

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this property.

Two instances of ExchangeProperty are considered equal if they have the same namespace and identifier, regardless of their type (as in getType()). This allows differently typed properties to refer to the same value, assuming their types are compatible (one is derived from the other).

Overrides:

equals in class Object

Parameters:

o - the object with which to compare

Returns:

true if the specified object is an ExchangeProperty and has the same namespace and identifier as this one

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

public static <T> ExchangeProperty<T> create(String namespace,
                                             String identifier,
                                             Class<T> type)

Creates a new ExchangeProperty.

Each property is created with a namespace and an identifier. The namespace is used to group related properties and to avoid naming collisions; it is typically a reverse domain name. The identifier is a unique value within the given namespace. Any leading/trailing whitespace will be removed/ignored from both the namespace and identifier.

Type Parameters:

T - the value type

Parameters:

namespace - the property namespace (typically a reverse domain name, such as 'com.example.group')

identifier - the property identifier, which must be unique within the given namespace

type - the class of the value type

Returns:

the new property

Throws:

IllegalArgumentException - if the namespace or identifier is blank/empty