org.yarnandtail.andhow.api

Class PropertyNaming

java.lang.Object

org.yarnandtail.andhow.api.PropertyNaming

public class PropertyNaming
extends Object

Names by which a Property is recognized. NamingStrategy returns an instance of this to create the names for a property. Names here are the canonical name and any aliases.

Author:

ericeverman

Constructor Summary

Constructors

Constructor and Description
PropertyNaming(EffectiveName canonicalName, List<EffectiveName> aliases)

Method Summary

Modifier and Type	Method and Description
List<EffectiveName>	getAliases() All aliases for the property.
EffectiveName	getCanonicalName() The canonical name of the property.
List<EffectiveName>	getInAliases() A list of the in-type aliases.
List<EffectiveName>	getOutAliases() A list of the out-type aliases.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyNaming

public PropertyNaming(EffectiveName canonicalName,
                      List<EffectiveName> aliases)

Method Detail

getCanonicalName

public EffectiveName getCanonicalName()

The canonical name of the property.

Returns:

getAliases

public List<EffectiveName> getAliases()

All aliases for the property. The naming strategy may be directed to add or remove aliases from the ones requested for a property to resolve conflicts, but nominally this is the list of aliases (both in and out aliases) requested by the Property.

Returns:

getInAliases

public List<EffectiveName> getInAliases()

A list of the in-type aliases.

Returns:

getOutAliases

public List<EffectiveName> getOutAliases()

A list of the out-type aliases.

Returns: