org.yarnandtail.andhow.api

Class Name

java.lang.Object

org.yarnandtail.andhow.api.Name

Direct Known Subclasses:

EffectiveName

public class Name
extends Object

A name for a Property, either incoming (when read by a property Loader) or outgoing (when properties are exported to some destination).

Author:

ericeverman

Field Summary

Fields

Modifier and Type	Field and Description
static String	ILLEGAL_PROPERTY_NAME_CHARS These characters are not allowed in Property names because they may collide with characters allowed in various formats, in particular, uri style JNDI names or property files conventions.

Constructor Summary

Constructors

Constructor and Description
Name(String name, boolean in, boolean out)

Method Summary

Modifier and Type	Method and Description
String	getActualName() The actual, originally name.
boolean	isIn() If true, this name is recognized when reading a property from a configuration source.
boolean	isOut() If true, this name is used when exporting properties to some other system.
static boolean	isValidPropertyName(String name) Returns true if the name contains no special characters, as defined in ILLEGAL_PROPERTY_NAME_CHARS.

Methods inherited from class java.lang.Object

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

Field Detail

ILLEGAL_PROPERTY_NAME_CHARS

public static String ILLEGAL_PROPERTY_NAME_CHARS

These characters are not allowed in Property names because they may collide with characters allowed in various formats, in particular, uri style JNDI names or property files conventions. URLs require encoding for these characters: [whitespace];/?:@=&"<>#%{}|\^~[]`

Constructor Detail

Name

public Name(String name,
            boolean in,
            boolean out)

Method Detail

isIn

public boolean isIn()

If true, this name is recognized when reading a property from a configuration source. When attempting to match an incoming property name, the effective name should be used and the incoming name should be transformed using the NamingStructure.transformIncomingClasspathName().

Returns:

isOut

public boolean isOut()

If true, this name is used when exporting properties to some other system. When exporting, the actual name is typically used, however, its possible that an exporter may have a reason to use the effective name.

Returns:

getActualName

public String getActualName()

The actual, originally name.

Returns:

isValidPropertyName

public static boolean isValidPropertyName(String name)

Returns true if the name contains no special characters, as defined in ILLEGAL_PROPERTY_NAME_CHARS. The alias is also not allowed to be null, empty, or start/end with a dot (.) character.

Parameters:

name -

Returns: