Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> aendvari >> cerberus >> component >> [ descriptor overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.aendvari.cerberus.component.descriptor
Class ComponentDefinition  

java.lang.Object
  com.aendvari.cerberus.component.descriptor.ComponentDefinition

---

public class ComponentDefinition

extends java.lang.Object

Describes the various properties of a component.

The messages and attributes for a component are described by this class.

A component may extend one or more definitions. The messages and attributes of the definition are inherited.

---

Field Summary
protected  java.util.HashMap	attributes           The attributes for this component.
protected  java.lang.String	backingClass           The backing class for this component.
protected  java.util.ArrayList	components           The components within this component.
protected  java.lang.String	description           The description of this component.
protected  java.util.HashMap	messages           The messages for this component.
protected  java.lang.String	name           The name of this component.
protected  java.util.ArrayList	parents           The definitions this component extends.

 

Constructor Summary

ComponentDefinition()           Constructs a ComponentDefinition instance.

ComponentDefinition(ComponentDefinition definition)           Constructs a ComponentDefinition instance as a copy of the one supplied.

 

Method Summary
void	addAttribute(ComponentAttribute attribute)           Adds an attribute to this component.
void	addComponent(ComponentInstance component)           Adds a component to this composite.
void	addMessage(ComponentMessage message)           Adds a message to this component.
void	addParent(java.lang.String definition)           Adds a parent definition that this component extends.
ComponentAttribute	getAttribute(java.lang.String name)           Returns the specified attribute.
java.util.Collection	getAttributes()           Returns the attributes of this component.
java.lang.String	getBackingClass()           Returns the class of this component.
java.util.Collection	getComponents()           Returns the components of this composite.
java.lang.String	getDescription()           Returns the description of this component.
ComponentMessage	getMessage(java.lang.String name)           Returns the specified message.
java.util.Collection	getMessages()           Returns the messages of this component.
java.lang.String	getName()           Returns the name of this component.
java.util.Collection	getParents()           Returns the definitions this component extends.
void	setBackingClass(java.lang.String setClass)           Sets the class of this component.
void	setDescription(java.lang.String setDescription)           Sets the description of this component.
void	setName(java.lang.String setName)           Sets the name of this component.
java.lang.String	toString()           Convert this Object to a human-readable String.
void	updateAttribute(java.lang.String name, ComponentAttribute attribute)           Updates the specified attribute.
void	updateMessage(java.lang.String name, ComponentMessage message)           Updates the specified message.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

name

protected java.lang.String name

The name of this component.

---

description

protected java.lang.String description

The description of this component.

---

backingClass

protected java.lang.String backingClass

The backing class for this component.

---

parents

protected java.util.ArrayList parents

The definitions this component extends.

---

attributes

protected java.util.HashMap attributes

The attributes for this component.

---

messages

protected java.util.HashMap messages

The messages for this component.

---

components

protected java.util.ArrayList components

The components within this component.

Constructor Detail

ComponentDefinition

public ComponentDefinition()

Constructs a ComponentDefinition instance.

---

ComponentDefinition

public ComponentDefinition(ComponentDefinition definition)

Constructs a ComponentDefinition instance as a copy of the one supplied.

Method Detail

setName

public void setName(java.lang.String setName)

Sets the name of this component.

---

getName

public java.lang.String getName()

Returns the name of this component.

---

setDescription

public void setDescription(java.lang.String setDescription)

Sets the description of this component.

---

getDescription

public java.lang.String getDescription()

Returns the description of this component.

---

setBackingClass

public void setBackingClass(java.lang.String setClass)

Sets the class of this component.

---

getBackingClass

public java.lang.String getBackingClass()

Returns the class of this component.

---

addParent

public void addParent(java.lang.String definition)

Adds a parent definition that this component extends.

---

getParents

public java.util.Collection getParents()

Returns the definitions this component extends.

---

addAttribute

public void addAttribute(ComponentAttribute attribute)

Adds an attribute to this component.

---

updateAttribute

public void updateAttribute(java.lang.String name,
                            ComponentAttribute attribute)

Updates the specified attribute. This allows the attribute to be renamed.

---

getAttribute

public ComponentAttribute getAttribute(java.lang.String name)

Returns the specified attribute.

---

getAttributes

public java.util.Collection getAttributes()

Returns the attributes of this component.

---

addMessage

public void addMessage(ComponentMessage message)

Adds a message to this component.

---

updateMessage

public void updateMessage(java.lang.String name,
                          ComponentMessage message)

Updates the specified message. This allows the message to be renamed.

---

getMessage

public ComponentMessage getMessage(java.lang.String name)

Returns the specified message.

---

getMessages

public java.util.Collection getMessages()

Returns the messages of this component.

---

addComponent

public void addComponent(ComponentInstance component)

Adds a component to this composite.

---

getComponents

public java.util.Collection getComponents()

Returns the components of this composite.

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> aendvari >> cerberus >> component >> [ descriptor overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---