ComponentDefinition (Fujion Core Libraries 1.0.1 API)

java.lang.Object
- org.fujion.annotation.ComponentDefinition

```
public class ComponentDefinition
extends Object
```
Stores metadata about a component, as derived from component annotations.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ComponentDefinition.Cardinality` Represents the cardinality of a child tag.
`static class`	`ComponentDefinition.DeferredSetter` Stores a method invocation to be executed at a later time.

Constructor Summary

Constructors
Constructor and Description
`ComponentDefinition(Class<? extends BaseComponent> componentClass)` Creates a component definition derived from annotation information within the specified class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`childrenAllowed()`
`Component.ContentHandling`	`contentHandling()` Returns how to handle content for this component type.
`boolean`	`equals(Object object)`
`ComponentDefinition.Cardinality`	`getCardinality(String childTag)` Returns the cardinality of a child tag.
`Map<String,ComponentDefinition.Cardinality>`	`getChildTags()` Returns an immutable map of all child tags.
`Class<? extends BaseComponent>`	`getComponentClass()` Returns the implementation class for this component type.
`ComponentFactory`	`getFactory()` Returns a factory instance for this component.
`Class<? extends ComponentFactory>`	`getFactoryClass()` Returns the factory class for this component type.
`Map<String,Method>`	`getFactoryParameters()` Returns an immutable map of factory parameters.
`Map<String,Method>`	`getGetters()` Returns an immutable map of getter methods.
`Set<String>`	`getParentTags()` Returns an immutable set of parent tags.
`Object`	`getProperty(BaseComponent instance, String name)` Returns The value of the named property.
`Map<String,Method>`	`getSetters()` Returns an immutable map of setter methods.
`String`	`getTag()` Returns the XML tag for this component type.
`String`	`getWidgetClass()` Returns the javascript class for the widget.
`String`	`getWidgetModule()` Returns the javascript module containing the widget class.
`boolean`	`isParentTag(String tag)` Returns true if the tag is a valid parent tag.
`ComponentDefinition.DeferredSetter`	`setProperty(BaseComponent instance, String name, Object value)` Sets a property value or defers that operation if the property is marked as such.
`void`	`validateChild(ComponentDefinition childDefinition, IntSupplier childCount)`
`void`	`validateParent(ComponentDefinition parentDefinition)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ComponentDefinition
```
public ComponentDefinition(Class<? extends BaseComponent> componentClass)
```
    Creates a component definition derived from annotation information within the specified class.
    
    Parameters:
    
    componentClass - A component class.
- Method Detail
  - getProperty
```
public Object getProperty(BaseComponent instance,
                          String name)
                   throws Exception
```
    Returns The value of the named property.
    
    Parameters:
    
    instance - Instance to retrieve property from.
    
    name - Name of property.
    
    Returns:
    
    The property value.
    
    Throws:
    
    Exception - Unspecified exception
  - setProperty
```
public ComponentDefinition.DeferredSetter setProperty(BaseComponent instance,
                                                      String name,
                                                      Object value)
```
    Sets a property value or defers that operation if the property is marked as such.
    
    Parameters:
    
    instance - Instance containing the property or attribute map.
    
    name - Name of property or attribute. If prefixed with "@", is interpreted as an attribute name; otherwise as a property name.
    
    value - The value to set.
    
    Returns:
    
    Null if the operation occurred, or a DeferredSetter object if deferred.
  - getTag
```
public String getTag()
```
    Returns the XML tag for this component type.
    
    Returns:
    
    An XML tag.
  - getComponentClass
```
public Class<? extends BaseComponent> getComponentClass()
```
    Returns the implementation class for this component type.
    
    Returns:
    
    Implementation class.
  - getFactoryClass
```
public Class<? extends ComponentFactory> getFactoryClass()
```
    Returns the factory class for this component type.
    
    Returns:
    
    Factory class.
  - getFactory
```
public ComponentFactory getFactory()
```
    Returns a factory instance for this component.
    
    Returns:
    
    The component factory.
  - getWidgetModule
```
public String getWidgetModule()
```
    Returns the javascript module containing the widget class.
    
    Returns:
    
    Widget module.
  - getWidgetClass
```
public String getWidgetClass()
```
    Returns the javascript class for the widget.
    
    Returns:
    
    Widget class.
  - getCardinality
```
public ComponentDefinition.Cardinality getCardinality(String childTag)
```
    Returns the cardinality of a child tag.
    
    Parameters:
    
    childTag - A child tag.
    
    Returns:
    
    Cardinality of the child tag, or null if the tag is not a valid child.
  - getChildTags
```
public Map<String,ComponentDefinition.Cardinality> getChildTags()
```
    Returns an immutable map of all child tags.
    
    Returns:
    
    Map of child tags.
  - childrenAllowed
```
public boolean childrenAllowed()
```
  - validateChild
```
public void validateChild(ComponentDefinition childDefinition,
                          IntSupplier childCount)
```
  - validateParent
```
public void validateParent(ComponentDefinition parentDefinition)
```
  - isParentTag
```
public boolean isParentTag(String tag)
```
    Returns true if the tag is a valid parent tag.
    
    Parameters:
    
    tag - Tag to be tested.
    
    Returns:
    
    True if the tag is a valid parent tag.
  - getParentTags
```
public Set<String> getParentTags()
```
    Returns an immutable set of parent tags.
    
    Returns:
    
    Set of valid parent tags.
  - contentHandling
```
public Component.ContentHandling contentHandling()
```
    Returns how to handle content for this component type.
    
    Returns:
    
    How to handle content.
  - getGetters
```
public Map<String,Method> getGetters()
```
    Returns an immutable map of getter methods.
    
    Returns:
    
    Map of getter methods.
  - getSetters
```
public Map<String,Method> getSetters()
```
    Returns an immutable map of setter methods.
    
    Returns:
    
    Map of setter methods.
  - getFactoryParameters
```
public Map<String,Method> getFactoryParameters()
```
    Returns an immutable map of factory parameters.
    
    Returns:
    
    Map of factory parameters.
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object

Class ComponentDefinition

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComponentDefinition

Method Detail

getProperty

setProperty

getTag

getComponentClass

getFactoryClass

getFactory

getWidgetModule

getWidgetClass

getCardinality

getChildTags

childrenAllowed

validateChild

validateParent

isParentTag

getParentTags

contentHandling

getGetters

getSetters

getFactoryParameters

equals