org.yarnandtail.andhow.api

Class EffectiveName

java.lang.Object

org.yarnandtail.andhow.api.Name

org.yarnandtail.andhow.api.EffectiveName

public class EffectiveName
extends Name

A name for a Property that has been processed by a NamingStrategy to create an effectiveIn name, which may be different than the original name. The NamingStrategy is also responsible to creating an effectiveIn name. An effectiveIn name is the name that is matched on when trying to match up incoming properties names found by a Loader. This is distinct from the actual name to accommodate case insensitive naming. For instance, if a property is aliased as 'bob', the effectiveIn name may be 'BOB' with all incoming names also converted to uppercase.

Author:

ericeverman

Field Summary

Fields inherited from class org.yarnandtail.andhow.api.Name

ILLEGAL_PROPERTY_NAME_CHARS

Constructor Summary

Constructors

Constructor and Description
EffectiveName(String actual, String effectiveIn, boolean in, boolean out) A new instance using the actual name as the effective out.
EffectiveName(String actual, String effectiveIn, String effectiveOut, boolean in, boolean out) A new instance explicitly providing the effective out name.

Method Summary

Modifier and Type	Method and Description
String	getEffectiveInName() The name as transformed by the NamingStrategy.
String	getEffectiveOutName()

Methods inherited from class org.yarnandtail.andhow.api.Name

getActualName, isIn, isOut, isValidPropertyName

Methods inherited from class java.lang.Object

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

Constructor Detail

EffectiveName

public EffectiveName(String actual,
                     String effectiveIn,
                     boolean in,
                     boolean out)

A new instance using the actual name as the effective out.

Parameters:

actual -

effectiveIn -

in -

out -

EffectiveName

public EffectiveName(String actual,
                     String effectiveIn,
                     String effectiveOut,
                     boolean in,
                     boolean out)

A new instance explicitly providing the effective out name.

Parameters:

actual -

effectiveIn -

effectiveOut -

in -

out -

Method Detail

getEffectiveInName

public String getEffectiveInName()

The name as transformed by the NamingStrategy.

Returns:

getEffectiveOutName

public String getEffectiveOutName()