org.jasig.cas.client.configuration
Class ConfigurationKey<E>

java.lang.Object
  org.jasig.cas.client.configuration.ConfigurationKey<E>

public final class ConfigurationKey<E>
extends Object

Holder class to represent a particular configuration key and its optional default value.

Since:

3.4.0

Author:

Scott Battaglia

Constructor Summary

ConfigurationKey(String name)

ConfigurationKey(String name, E defaultValue)

Method Summary

E	getDefaultValue() The (optional) default value to use when this configuration key is not set.
String	getName() The referencing name of the configuration key (i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationKey

public ConfigurationKey(String name)

ConfigurationKey

public ConfigurationKey(String name,
                        E defaultValue)

Method Detail

getName

public String getName()

The referencing name of the configuration key (i.e. what you would use to look it up in your configuration strategy)

Returns:

the name. MUST NOT BE NULL.

getDefaultValue

public E getDefaultValue()

The (optional) default value to use when this configuration key is not set. If a value is provided it should be used. A null value indicates that there is no default.

Returns:

the default value or null.