org.springframework.boot.context.properties.source

Class MutuallyExclusiveConfigurationPropertiesException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.boot.context.properties.source.MutuallyExclusiveConfigurationPropertiesException

All Implemented Interfaces:

Serializable

public class MutuallyExclusiveConfigurationPropertiesException
extends RuntimeException

Exception thrown when more than one mutually exclusive configuration property has been configured.

Since:

2.6.0

Author:

Andy Wilkinson, Phillip Webb

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MutuallyExclusiveConfigurationPropertiesException(Collection<String> configuredNames, Collection<String> mutuallyExclusiveNames) Creates a new instance for mutually exclusive configuration properties when two or more of those properties have been configured.

Method Summary

Modifier and Type	Method and Description
Set<String>	getConfiguredNames() Return the names of the properties that have been configured.
Set<String>	getMutuallyExclusiveNames() Return the names of the properties that are mutually exclusive.
static void	throwIfMultipleNonNullValuesIn(Consumer<Map<String,Object>> entries) Throw a new MutuallyExclusiveConfigurationPropertiesException if multiple non-null values are defined in a set of entries.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MutuallyExclusiveConfigurationPropertiesException

public MutuallyExclusiveConfigurationPropertiesException(Collection<String> configuredNames,
                                                         Collection<String> mutuallyExclusiveNames)

Creates a new instance for mutually exclusive configuration properties when two or more of those properties have been configured.

Parameters:

configuredNames - the names of the properties that have been configured

mutuallyExclusiveNames - the names of the properties that are mutually exclusive

Method Detail

getConfiguredNames

public Set<String> getConfiguredNames()

Return the names of the properties that have been configured.

Returns:

the names of the configured properties

getMutuallyExclusiveNames

public Set<String> getMutuallyExclusiveNames()

Return the names of the properties that are mutually exclusive.

Returns:

the names of the mutually exclusive properties

throwIfMultipleNonNullValuesIn

public static void throwIfMultipleNonNullValuesIn(Consumer<Map<String,Object>> entries)

Throw a new MutuallyExclusiveConfigurationPropertiesException if multiple non-null values are defined in a set of entries.

Parameters:

entries - a consumer used to populate the entries to check