Module org.microbean.qualifier

Package org.microbean.qualifier

Class Binding<V,B extends Binding<V,B>>

java.lang.Object

org.microbean.qualifier.Binding<V,B>

Type Parameters:

V - the type of a Binding's value and of its attribute values

B - the type of the subclass

All Implemented Interfaces:

Comparable<B>, Constable

Direct Known Subclasses:

Qualifier

public abstract class Binding<V,B extends Binding<V,B>>
extends Object
implements Comparable<B>, Constable

An abstract attributed name-value pair.

Author:

Laird Nelson

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Binding(String name, V value, Map<? extends String,?> attributes, Map<? extends String,?> info)	Creates a new Binding.

Method Summary

Modifier and Type	Method	Description
final SortedMap<String,Object>	attributes()	Returns an immutable SortedMap representing any attributes further describing this Binding.
int	compareTo(B other)	Returns an int representing a comparison of this Binding with the supplied Binding, by considering the names, values and attributes of both Bindings.
Optional<? extends ConstantDesc>	describeConstable()	Returns an Optional housing a ConstantDesc describing this Binding, if this Binding is capable of being represented as a dynamic constant, or an empty Optional if not.
protected MethodHandleDesc	describeConstructor()	Returns a MethodHandleDesc describing the constructor or static method that will be used to create a dynamic constant representing this Binding.
boolean	equals(Object other)	Returns true if the supplied Object is equal to this Binding.
int	hashCode()	Returns a hashcode for this Binding that represents its name, value and attributes.
final SortedMap<String,Object>	info()	Returns an immutable SortedMap representing any informational-only attributes further describing this Binding.
final String	name()	Returns the name of this Binding.
String	toString()	Returns a String representation of this Binding.
final V	value()	Returns the value of this Binding, which may be null.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Binding

protected Binding(String name,
 V value,
 Map<? extends String,?> attributes,
 Map<? extends String,?> info)

Creates a new Binding.

Parameters:

name - the name; must not be null

value - the value; may be null

attributes - further describing this Binding; may be null

info - informational attributes further describing this Binding that are not considered by its equals(Object) implementation; may be null

See Also:

• name()
• value()
• attributes()
• info()

Method Details

name

public final String name()

Returns the name of this Binding.

Returns:

the name of this Binding

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

value

public final V value()

Returns the value of this Binding, which may be null.

Returns:

the value of this Binding

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method may return null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

attributes

public final SortedMap<String,Object> attributes()

Returns an immutable SortedMap representing any attributes further describing this Binding.

The attributes are considered by the equals(Object) method.

Returns:

the attributes of this Binding

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

info

public final SortedMap<String,Object> info()

Returns an immutable SortedMap representing any informational-only attributes further describing this Binding.

The attributes are not considered by the equals(Object) method.

Returns:

the informational attributes of this Binding

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

describeConstable

public Optional<? extends ConstantDesc> describeConstable()

Returns an Optional housing a ConstantDesc describing this Binding, if this Binding is capable of being represented as a dynamic constant, or an empty Optional if not.

Specified by:

describeConstable in interface Constable

Returns:

an Optional housing a ConstantDesc describing this Binding, if this Binding is capable of being represented as a dynamic constant, or an empty Optional if not

See Also:

• describeConstructor()
• Dynamically-computed constants

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

describeConstructor

protected MethodHandleDesc describeConstructor()

Returns a MethodHandleDesc describing the constructor or static method that will be used to create a dynamic constant representing this Binding.

Returns:

a MethodHandleDesc describing the constructor or static method that will be used to create a dynamic constant representing this Binding

Idempotency:

This method is, and its overrides must be, idempotent and deterministic.

Nullability:

This method does not, and its overrides must not, return null.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.

hashCode

public int hashCode()

Returns a hashcode for this Binding that represents its name, value and attributes.

A subclass that overrides this method must also override the equals(Object) and compareTo(Binding) methods accordingly.

Overrides:

hashCode in class Object

Returns:

a hashcode for this Binding

See Also:

• equals(Object)
• compareTo(Binding)

Idempotency:

This method is, and its overrides must be, idempotent and deterministic.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.

compareTo

public int compareTo(B other)

Returns an int representing a comparison of this Binding with the supplied Binding, by considering the names, values and attributes of both Bindings.

Any attribute values that are not Comparable instances will be compared based on their string representations. It is strongly recommended that attribute values implement Comparable.

This method is, and its overrides must be, consistent with equals.

A subclass that overrides this method must also override the hashCode() and equals(Object) methods accordingly.

Specified by:

compareTo in interface Comparable<V>

Parameters:

other - the other Binding; may be null in which case a negative value will be returned

Returns:

an int representing a comparison of this Binding with the supplied Binding

See Also:

• hashCode()
• equals(Object)

Idempotency:

This method is, and its overrides must be, idempotent and deterministic.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.

equals

public boolean equals(Object other)

Returns true if the supplied Object is equal to this Binding.

The supplied Object is considered to be equal to this Binding if and only if:

• Its class is identical to this Binding's class, and
• Its name is equal to this Binding's name, and
• Its value is equal to this Binding's value, and
• Its attributes are equal to this Binding's attributes

A subclass that overrides this method must also override the hashCode() and compareTo(Binding) methods accordingly.

Overrides:

equals in class Object

Parameters:

other - the Object to test; may be null in which case false will be returned

Returns:

true if the supplied Object is equal to this Binding

See Also:

• hashCode()
• compareTo(Binding)

Idempotency:

This method is, and its overrides must be, idempotent and deterministic.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.

toString

public String toString()

Returns a String representation of this Binding.

The format of the returned String is deliberately undefined and may change between versions of this class without prior notice.

Overrides:

toString in class Object

Returns:

a String representation of this Binding

Idempotency:

This method is, and its overrides must be, idempotent and deterministic.

Nullability:

This method does not, and its overrides must not, return null.

Thread Safety:

This method is, and its overrides must be, safe for concurrent use by multiple threads.