org.yarnandtail.andhow.api

Class GroupProxyBase

java.lang.Object

org.yarnandtail.andhow.api.GroupProxyBase

All Implemented Interfaces:

GroupProxy

Direct Known Subclasses:

GroupProxyImmutable, GroupProxyMutable

public abstract class GroupProxyBase
extends Object
implements GroupProxy

Author:

ericeverman

Field Summary

Fields

Modifier and Type	Field and Description
protected List<NameAndProperty>	props

Constructor Summary

Constructors

Constructor and Description
GroupProxyBase(String canonicalName, String javaCanonicalName) Constructs a new instance w/ final unmodifiable fields.
GroupProxyBase(String canonicalName, String javaCanonicalName, boolean userGroup)
GroupProxyBase(String canonicalName, String javaCanonicalName, List<NameAndProperty> props)
GroupProxyBase(String canonicalName, String javaCanonicalName, List<NameAndProperty> props, boolean userGroup)

Method Summary

Modifier and Type	Method and Description
String	getCanonicalName() Returns the AndHow canonical name of the class this group is proxying.
String	getCanonicalName(Property<?> memberProperty) The complete canonical name of a Property in this Group.
String	getJavaCanonicalName() Returns the Java canonical name of the class this group is proxying.
List<NameAndProperty>	getProperties() Returns a complete list of all AndHow Properties in this group.
Class<?>	getProxiedGroup() The proxied class or interface containing Properties that this proxy wraps.
String	getSimpleName(Property<?> memberProperty) The simple name of a Property in this Group.
boolean	isUserGroup() Returns true if this is a group created for user properties, which is the typical case.

Methods inherited from class java.lang.Object

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

Field Detail

props

protected final List<NameAndProperty> props

Constructor Detail

GroupProxyBase

public GroupProxyBase(String canonicalName,
                      String javaCanonicalName)

Constructs a new instance w/ final unmodifiable fields.

Parameters:

canonicalName -

javaCanonicalName -

GroupProxyBase

public GroupProxyBase(String canonicalName,
                      String javaCanonicalName,
                      boolean userGroup)

GroupProxyBase

public GroupProxyBase(String canonicalName,
                      String javaCanonicalName,
                      List<NameAndProperty> props)

GroupProxyBase

public GroupProxyBase(String canonicalName,
                      String javaCanonicalName,
                      List<NameAndProperty> props,
                      boolean userGroup)

Method Detail

getCanonicalName

public String getCanonicalName()

Description copied from interface: GroupProxy

Returns the AndHow canonical name of the class this group is proxying. This name is dot separated, including the package and nested inner classes. It does not follow the Java convention of separating inner classes using dollar signs. For a class with the full name 'org.bigcorp.MyClass', an inner class named 'MyInner' would have the canonical name 'org.bigcorp.MyClass.MyInner'.

Specified by:

getCanonicalName in interface GroupProxy

Returns:

The canonical name of the group.

getJavaCanonicalName

public String getJavaCanonicalName()

Description copied from interface: GroupProxy

Returns the Java canonical name of the class this group is proxying. This name follows the Java convention which is to dot separate the package and class name, but to use dollar signs ($) to separate any inner classes. For a class with the full name 'org.bigcorp.MyClass', an inner class named 'MyInner' would have the Java canonical name 'org.bigcorp.MyClass$MyInner'.

Specified by:

getJavaCanonicalName in interface GroupProxy

Returns:

The canonical name of the group.

getProperties

public List<NameAndProperty> getProperties()

Description copied from interface: GroupProxy

Returns a complete list of all AndHow Properties in this group.

Specified by:

getProperties in interface GroupProxy

Returns:

An unmodifiable list of registered properties.

getProxiedGroup

public Class<?> getProxiedGroup()

Description copied from interface: GroupProxy

The proxied class or interface containing Properties that this proxy wraps.

Specified by:

getProxiedGroup in interface GroupProxy

Returns:

getSimpleName

public String getSimpleName(Property<?> memberProperty)

Description copied from interface: GroupProxy

The simple name of a Property in this Group. The simple name has no package or containing class name, it is just the name of the variable the Property was assigned to at creation. If the passed memberProperty is not a member of this Group, null is returned.

Specified by:

getSimpleName in interface GroupProxy

Returns:

getCanonicalName

public String getCanonicalName(Property<?> memberProperty)

Description copied from interface: GroupProxy

The complete canonical name of a Property in this Group. The canonical name includes the package and all nested inner classes separated by dots, ending with the name of the variable the Property was assigned to at creation. If the passed memberProperty is not a member of this Group, null is returned.

Specified by:

getCanonicalName in interface GroupProxy

Returns:

isUserGroup

public boolean isUserGroup()

Description copied from interface: GroupProxy

Returns true if this is a group created for user properties, which is the typical case. Returns false if this is an internally created group for loader properties or groups used to configure AndHow itself. In some reports it is useful to differentiate the groups and properties the user actually created vs the ones that are just part of the system.

Specified by:

isUserGroup in interface GroupProxy

Returns: