org.yarnandtail.andhow.name

Class CaseInsensitiveNaming

java.lang.Object

org.yarnandtail.andhow.name.CaseInsensitiveNaming

All Implemented Interfaces:

NamingStrategy

public class CaseInsensitiveNaming
extends Object
implements NamingStrategy

Case insensitive naming.

Author:

eeverman

Constructor Summary

Constructors

Constructor and Description
CaseInsensitiveNaming()

Method Summary

Modifier and Type	Method and Description
PropertyNaming	buildNames(Property prop, GroupProxy parentGroup) Build a list of names for the Property
PropertyNaming	buildNamesFromCanonical(Property prop, GroupProxy parentGroup, String canonicalName)
String	getNameMatchingDescription() Returns a description of how names are matched for use in samples and documentation.
String	toEffectiveName(String name) Transforms a property name found in a property source (like a properties file, cmd line argument, env variable, etc.) into the form needed to match the expected property names.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yarnandtail.andhow.api.NamingStrategy

getUriName, isUriNameDistinct

Constructor Detail

CaseInsensitiveNaming

public CaseInsensitiveNaming()

Method Detail

buildNames

public PropertyNaming buildNames(Property prop,
                                 GroupProxy parentGroup)
                          throws Exception

Description copied from interface: NamingStrategy

Build a list of names for the Property

Specified by:

buildNames in interface NamingStrategy

Parameters:

prop - The Property to be named

parentGroup - Properties are contained in Group

Returns:

Null if the passed Property is not part of the Group.

Throws:

Exception - A security exception trying to read fields of a Group via reflection.

buildNamesFromCanonical

public PropertyNaming buildNamesFromCanonical(Property prop,
                                              GroupProxy parentGroup,
                                              String canonicalName)

toEffectiveName

public String toEffectiveName(String name)

Description copied from interface: NamingStrategy

Transforms a property name found in a property source (like a properties file, cmd line argument, env variable, etc.) into the form needed to match the expected property names. For the nominal case, this means converting it to upper case for case insensitive comparison.

Specified by:

toEffectiveName in interface NamingStrategy

Returns:

getNameMatchingDescription

public String getNameMatchingDescription()

Description copied from interface: NamingStrategy

Returns a description of how names are matched for use in samples and documentation. For case insensitive matching, it might return something like: Names are matched in a case insensitive way, so "Bob" would match "bOB".

Specified by:

getNameMatchingDescription in interface NamingStrategy

Returns:

A short string to be used in generated samples and documentation.