org.yarnandtail.andhow.api

Interface NamingStrategy

All Known Implementing Classes:

CaseInsensitiveNaming

public interface NamingStrategy

Author:

eeverman

Method Summary

Modifier and Type	Method and Description
PropertyNaming	buildNames(Property prop, GroupProxy containingGroup) Build a list of names for the Property
String	getNameMatchingDescription() Returns a description of how names are matched for use in samples and documentation.
default String	getUriName(String classpathName) Converts a standard classpath style property name to a URI based one.
default boolean	isUriNameDistict(String classpathName) Returns true if the Uri version of the passed name would be a disctict name from the passed name.
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.

Method Detail

buildNames

PropertyNaming buildNames(Property prop,
                          GroupProxy containingGroup)
                   throws Exception

Build a list of names for the Property

Parameters:

prop - The Property to be named

containingGroup - 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.

toEffectiveName

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. For the nominal case, this means converting it to upper case for case insensitive comparison.

Parameters:

name -

Returns:

getNameMatchingDescription

String getNameMatchingDescription()

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".

Returns:

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

getUriName

default String getUriName(String classpathName)

Converts a standard classpath style property name to a URI based one. Standard classpath style names look like this: com.acme.bigapp.PROPERTY_NAME. A URI version of that would be this: com/acme/bigapp/PROPERTY_NAME. No trimming or cleanup is done of the passed classpathNames - they are assumed to be in final form. Empty and null classpathNames shouldn't happen, but they just return themselves, respectively.

Parameters:

classpathName -

Returns:

null if null is passed.

isUriNameDistict

default boolean isUriNameDistict(String classpathName)

Returns true if the Uri version of the passed name would be a disctict name from the passed name. If this returns false, the URI name and the classpathName would be the same. If passed null, this returns false.

Parameters:

classpathName -

Returns: