org.jvnet.hk2.config
Class ConfigModel

java.lang.Object
  org.jvnet.hk2.config.ConfigModel

public final class ConfigModel
extends java.lang.Object

Describes the configuration model for a particular class (called "target type" in this class.) TODO: we need to remember if element values are single-valued or multi-valued.

Author:

Kohsuke Kawaguchi

Nested Class Summary

static class	ConfigModel.Node
static class	ConfigModel.Property

Field Summary

com.sun.hk2.component.Holder<java.lang.Class>	classHolder Deferred reference to the class object that can load the configurable type
com.sun.hk2.component.Holder<java.lang.ClassLoader>	classLoaderHolder Deferred reference to the class loader that loaded the injector.
org.jvnet.hk2.component.Inhabitant<? extends ConfigInjector>	injector Reference to the ConfigInjector used to inject values to objects of this model.
java.lang.String	key If this model has any property that works as a key.
java.lang.String	keyedAs Fully-qualified name under which this type is indexed.
java.lang.String	targetTypeName Fully-qualified name of the target type that this injector works on.

Constructor Summary

ConfigModel(DomDocument document, org.jvnet.hk2.component.Inhabitant<? extends ConfigInjector> injector, org.jvnet.hk2.component.MultiMap<java.lang.String,java.lang.String> description)

Method Summary

java.lang.String	camelCaseToXML(java.lang.String camelCase)
ConfigModel.Property	findIgnoreCase(java.lang.String xmlName) Finds the ConfigModel.Property from either elements or attributes.
java.util.Set<java.lang.String>	getAttributeNames() Returns the set of possible attributes names on this configuration model.
java.lang.reflect.Method	getDuckMethod(java.lang.reflect.Method method) Obtains the duck method implementation from a method on the ConfigBeanProxy-derived interface.
ConfigModel.Property	getElement(java.lang.String elementName) Returns the Property model for an element associated with this model or null of the element name is not known,
ConfigModel.Property	getElementFromXMlName(java.lang.String xmlName)
java.util.Set<java.lang.String>	getElementNames() Returns the list of all posible elements names on this model
java.util.Set<java.lang.String>	getLeafElementNames() Returns the list of all the leaf attribute names on this model
<T extends ConfigBeanProxy> java.lang.Class<T>	getProxyType() Return the proxy type for this model
java.lang.String	getTagName() getter for tagName
ConfigModel.Property	toProperty(java.lang.reflect.Method method) Obtain XML names (like "abc-def") from strings like "getAbcDef" and "hasAbcDef".

Methods inherited from class java.lang.Object

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

Field Detail

injector

public final org.jvnet.hk2.component.Inhabitant<? extends ConfigInjector> injector

Reference to the ConfigInjector used to inject values to objects of this model.

classLoaderHolder

public final com.sun.hk2.component.Holder<java.lang.ClassLoader> classLoaderHolder

Deferred reference to the class loader that loaded the injector. This classloader can also load the configurable object.

classHolder

public final com.sun.hk2.component.Holder<java.lang.Class> classHolder

Deferred reference to the class object that can load the configurable type

targetTypeName

public final java.lang.String targetTypeName

Fully-qualified name of the target type that this injector works on.

keyedAs

public final java.lang.String keyedAs

Fully-qualified name under which this type is indexed. This is the class name where the key property is defined.

Null if this type is not keyed.

key

public final java.lang.String key

If this model has any property that works as a key.

See Also:

ConfigMetadata.KEY

Constructor Detail

ConfigModel

public ConfigModel(DomDocument document,
                   org.jvnet.hk2.component.Inhabitant<? extends ConfigInjector> injector,
                   org.jvnet.hk2.component.MultiMap<java.lang.String,java.lang.String> description)

Parameters:

description - The description of the model as written in the inhabitants file.

Method Detail

getTagName

public java.lang.String getTagName()

getter for tagName

Returns:

the element name of this model itself, if this element can appear globally Otherwise null

getAttributeNames

public java.util.Set<java.lang.String> getAttributeNames()

Returns the set of possible attributes names on this configuration model.

Returns:

the set of all possible attributes names on this model

getProxyType

public <T extends ConfigBeanProxy> java.lang.Class<T> getProxyType()

Return the proxy type for this model

Type Parameters:

T - the proxy type

Returns:

the class object for this proxy type

getLeafElementNames

public java.util.Set<java.lang.String> getLeafElementNames()

Returns the list of all the leaf attribute names on this model

Returns:

the list of all leaf attribute names.

getElementNames

public java.util.Set<java.lang.String> getElementNames()

Returns the list of all posible elements names on this model

Returns:

the list of all posible elements names.

getElement

public ConfigModel.Property getElement(java.lang.String elementName)

Returns the Property model for an element associated with this model or null of the element name is not known,

Parameters:

elementName - element name identifying the property

Returns:

the Property instance describing the element

getElementFromXMlName

public ConfigModel.Property getElementFromXMlName(java.lang.String xmlName)

getDuckMethod

public java.lang.reflect.Method getDuckMethod(java.lang.reflect.Method method)
                                       throws java.lang.ClassNotFoundException,
                                              java.lang.NoSuchMethodException

Obtains the duck method implementation from a method on the ConfigBeanProxy-derived interface.

Throws:

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

toProperty

public ConfigModel.Property toProperty(java.lang.reflect.Method method)

Obtain XML names (like "abc-def") from strings like "getAbcDef" and "hasAbcDef".

The conversion rule uses the model to find a good match.

camelCaseToXML

public java.lang.String camelCaseToXML(java.lang.String camelCase)

findIgnoreCase

public ConfigModel.Property findIgnoreCase(java.lang.String xmlName)

Finds the ConfigModel.Property from either elements or attributes.

Parameters:

xmlName - XML name to be searched.

Returns:

null if none is found.