Package com.helger.config.source

Class AbstractConfigurationSource

java.lang.Object

com.helger.config.source.AbstractConfigurationSource

All Implemented Interfaces:

IConfigurationSource, IConfigurationValueProvider

Direct Known Subclasses:

AbstractConfigurationSourceResource, ConfigurationSourceEnvVar, ConfigurationSourceFunction, ConfigurationSourceSystemProperty

@MustImplementEqualsAndHashcode
@Immutable
public abstract class AbstractConfigurationSource
extends Object
implements IConfigurationSource

Abstract base class for any configuration source.

Author:

Philip Helger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConfigurationSource(EConfigSourceType eSourceType, int nPriority)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
final int	getPriority()
final EConfigSourceType	getSourceType()
int	hashCode()
protected static final boolean	hasTrailingWhitespace(String s)
static boolean	isSecretKey(String sKey)
protected static <V> String	mapToStringIgnoreSecrets(Map<String,V> aMap)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.config.source.IConfigurationSource

isInitializedAndUsable

Methods inherited from interface com.helger.config.value.IConfigurationValueProvider

getConfigurationValue

Constructor Details

AbstractConfigurationSource

protected AbstractConfigurationSource(@Nonnull
 EConfigSourceType eSourceType,
 int nPriority)

Constructor

Parameters:

eSourceType - Configuration source type. May not be null.

nPriority - The priority to use. The higher the more important.

Method Details

hasTrailingWhitespace

protected static final boolean hasTrailingWhitespace(@Nullable
 String s)

getSourceType

@Nonnull
public final EConfigSourceType getSourceType()

Specified by:

getSourceType in interface IConfigurationSource

Returns:

The configuration source type. Never null.

getPriority

public final int getPriority()

Specified by:

getPriority in interface IConfigurationSource

Returns:

THe higher the priority the earlier it is checked. Values between Integer.MIN_VALUE and Integer.MAX_VALUE are allowed.

isSecretKey

public static boolean isSecretKey(@Nonnull
 String sKey)

mapToStringIgnoreSecrets

@Nonnull
protected static <V> String mapToStringIgnoreSecrets(@Nullable
 Map<String,V> aMap)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object