org.microbean.configuration.api

Class ConfigurationValue

java.lang.Object

org.microbean.configuration.api.ConfigurationValue

All Implemented Interfaces:

Serializable

public class ConfigurationValue
extends Object
implements Serializable

A value for a configuration property, particularly as exposed by an AmbiguousConfigurationValuesException.

Author:

Laird Nelson

See Also:

AmbiguousConfigurationValuesException, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigurationValue(Serializable source, Map<String,String> coordinates, String name, String value, boolean authoritative) Creates a new ConfigurationValue.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Returns true if the supplied Object is equal to this ConfigurationValue.
Map<String,String>	getCoordinates() Returns the configuration coordinates locating this ConfigurationValue in configuration space.
String	getName() Returns the name of the configuration property for which this ConfigurationValue is a value.
Object	getSource() Returns the system that created this ConfigurationValue.
String	getValue() Returns the actual value that this ConfigurationValue represents.
int	hashCode() Returns a hashcode for this ConfigurationValue.
boolean	isAuthoritative() Returns true if this ConfigurationValue is to be regarded as authoritative.
int	specificity() Returns the specificity of this ConfigurationValue.
String	toString() Returns a non-null String representation of this ConfigurationValue.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationValue

public ConfigurationValue(Serializable source,
                          Map<String,String> coordinates,
                          String name,
                          String value,
                          boolean authoritative)

Creates a new ConfigurationValue.

Parameters:

source - the system creating this ConfigurationValue; must not be null

coordinates - the configuration coordinates to which this ConfigurationValue applies; must be a subset of the configuration coordinates that resulted in this ConfigurationValue being created; may be null

name - the name of the configuration property for which this is a value; must not be null

value - the value; may be null

authoritative - whether this ConfigurationValue is to be considered authoritative

Throws:

NullPointerException - if either source or name is null

Method Detail

getSource

public final Object getSource()

Returns the system that created this ConfigurationValue.

This method never returns null.

Returns:

the system that created this ConfigurationValue; never null

getCoordinates

public final Map<String,String> getCoordinates()

Returns the configuration coordinates locating this ConfigurationValue in configuration space.

This method may return null.

Returns:

the configuration coordinates locating this ConfigurationValue in configuration space, or null

getName

public final String getName()

Returns the name of the configuration property for which this ConfigurationValue is a value.

This method never returns null.

Returns:

the name of the configuration property for which this ConfigurationValue is a value; never null

getValue

public final String getValue()

Returns the actual value that this ConfigurationValue represents.

This method may return null.

Returns:

the actual value that this ConfigurationValue represents, or null

isAuthoritative

public final boolean isAuthoritative()

Returns true if this ConfigurationValue is to be regarded as authoritative.

Returns:

true if this ConfigurationValue is to be regarded as authoritative; false otherwise

specificity

public final int specificity()

Returns the specificity of this ConfigurationValue.

The specificity of a ConfigurationValue is equal to the size of its configuration coordinates Map.

Returns:

the specificity of this ConfigurationValue; always zero or a positive integer

hashCode

public int hashCode()

Returns a hashcode for this ConfigurationValue.

Overrides:

hashCode in class Object

Returns:

a hashcode for this ConfigurationValue

equals

public boolean equals(Object other)

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

An Object is equal to a ConfigurationValue if:

• It is an instance of ConfigurationValue
• Its name and coordinates are equal to those of the ConfigurationValue to which it is being compared
• Its value is equal to that of the ConfigurationValue to which it is being compared

Overrides:

equals in class Object

Parameters:

other - the Object to test; may be null

Returns:

true if the supplied Object is equal to this ConfigurationValue; false otherwise

toString

public String toString()

Returns a non-null String representation of this ConfigurationValue.

This method never returns null.

Overrides of this method must not return null.

Overrides:

toString in class Object

Returns:

a non-null String representation of this ConfigurationValue