org.microbean.configuration.api

Class AmbiguousConfigurationValuesException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.microbean.configuration.api.ConfigurationException

org.microbean.configuration.api.AmbiguousConfigurationValuesException

All Implemented Interfaces:

Serializable

public class AmbiguousConfigurationValuesException
extends ConfigurationException

A ConfigurationException indicating that conflicting ConfigurationValues were found for a given configuration property request.

Author:

Laird Nelson

See Also:

ConfigurationValue, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AmbiguousConfigurationValuesException(String message, Throwable cause, Map<? extends String,? extends String> configurationCoordinates, String name, Collection<? extends ConfigurationValue> values) Creates a new AmbiguousConfigurationValuesException.

Method Summary

Modifier and Type	Method and Description
Map<? extends String,? extends String>	getCoordinates() Returns a Map representing the configuration coordinates in effect when this AmbiguousConfigurationValuesException was created.
String	getName() Returns the name of the configuration property for which a value was requested.
Collection<? extends ConfigurationValue>	getValues() Returns the Collection of conflicting values that caused this AmbiguousConfigurationValuesException to be created.
String	toString() Returns a non-null String representation of this AmbiguousConfigurationValuesException.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

AmbiguousConfigurationValuesException

public AmbiguousConfigurationValuesException(String message,
                                             Throwable cause,
                                             Map<? extends String,? extends String> configurationCoordinates,
                                             String name,
                                             Collection<? extends ConfigurationValue> values)

Creates a new AmbiguousConfigurationValuesException.

Parameters:

message - the error message; may be null

cause - the Throwable that caused this AmbiguousConfigurationValuesException to be created; may be null

configurationCoordinates - the configuration coordinates in effect at the time conflicting values were found; may be null

name - the name of the configuration property for which a value was requested; must not be null

values - the conflicting values; may be null

Throws:

NullPointerException - if name is null

Method Detail

getValues

public final Collection<? extends ConfigurationValue> getValues()

Returns the Collection of conflicting values that caused this AmbiguousConfigurationValuesException to be created.

This method will never return null.

Returns:

a non-null Collection of ConfigurationValues

getCoordinates

public final Map<? extends String,? extends String> getCoordinates()

Returns a Map representing the configuration coordinates in effect when this AmbiguousConfigurationValuesException was created.

This method never returns null.

Returns:

a non-null Map of configuration coordinates

getName

public final String getName()

Returns the name of the configuration property for which a value was requested.

This method never returns null.

Returns:

the name of the configuration property for which a value was requested; never null

toString

public String toString()

Returns a non-null String representation of this AmbiguousConfigurationValuesException.

This method never returns null.

Overrides of this method must not return null.

Overrides:

toString in class Throwable

Returns:

a non-null String representation of this AmbiguousConfigurationValuesException