org.yarnandtail.andhow.load.util

Class KeyObjectPair

java.lang.Object

org.yarnandtail.andhow.load.util.KeyObjectPair

public class KeyObjectPair
extends Object

Key-Object Pair Contains a String name and an Object value. Names are always trimmed (leading and trailing spaces removed) because they are expected to match up to AndHow Property canonical names or alias, which don't includes spaces. After trimming, names must be non-empty and non-null.

Constructor Summary

Constructors

Constructor and Description
KeyObjectPair(String name) Construct an instance with a null value.
KeyObjectPair(String name, Object value) New instance with name and value.

Method Summary

Modifier and Type	Method and Description
String	getName() The KeyObjectPair name, which has been trimmed to remove leading and trailing spaces.
Object	getValue() The value exactly as passed in the constructor, which may be null.
String	toString() String representation: name : "value" If the value is null, the string [null] is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyObjectPair

public KeyObjectPair(String name)
              throws ParsingException

Construct an instance with a null value.

Parameters:

name - A name that will be trimmed to remove all leading and trailing spaces.

Throws:

ParsingException - If the name is empty after trimming.

KeyObjectPair

public KeyObjectPair(String name,
                     Object value)
              throws ParsingException

New instance with name and value.

Parameters:

name - A name that will be trimmed to remove all leading and trailing spaces.

value - The value, which will not be trimmed or modified.

Throws:

ParsingException - If the name is empty after trimming.

Method Detail

getName

public String getName()

The KeyObjectPair name, which has been trimmed to remove leading and trailing spaces.

Returns:

getValue

public Object getValue()

The value exactly as passed in the constructor, which may be null.

Returns:

The value as set.

toString

public String toString()

String representation: name : "value" If the value is null, the string [null] is used.

Overrides:

toString in class Object

Returns:

A formatted string version of the instance.