|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A specification for a component, as read from an XML specification file.
A specification consists of
From this information, an actual component may be instantiated and initialized. Instantiating a component is usually a recursive process, since to initialize a container component, it is necessary to instantiate and initialize its contained components as well.
IComponent
,
IContainedComponent
,
IComponentSpecification
,
IPageLoader
Method Summary | |
void |
addAsset(java.lang.String name,
IAssetSpecification asset)
|
void |
addBeanSpecification(java.lang.String name,
IBeanSpecification specification)
|
void |
addComponent(java.lang.String id,
IContainedComponent component)
|
void |
addInjectSpecification(InjectSpecification spec)
Adds a InjectSpecification . |
void |
addParameter(IParameterSpecification spec)
Adds the parameter. |
void |
addPropertySpecification(IPropertySpecification spec)
Adds a new property specification. |
void |
addReservedParameterName(java.lang.String value)
Adds the value as a reserved name. |
boolean |
getAllowBody()
Returns true if the component is allowed to wrap other elements (static HTML or other components). |
boolean |
getAllowInformalParameters()
Returns true if the component allows informal parameters (parameters not formally defined). |
IAssetSpecification |
getAsset(java.lang.String name)
Returns the IAssetSpecification with the given name, or null if no such specification
exists. |
java.util.List |
getAssetNames()
Returns a List of the String names of all assets, in alphabetical order |
java.util.Collection |
getBeanNames()
Returns an unmodifiable collection of the names of all beans. |
IBeanSpecification |
getBeanSpecification(java.lang.String name)
Returns the IBeanSpecification for the given name, or null if not such specification
exists. |
IContainedComponent |
getComponent(java.lang.String id)
Returns the specification of a contained component with the given id, or null if no such contained component exists. |
java.lang.String |
getComponentClassName()
Returns the class name to be used when instantiating the component, or null if no class name was provided in the specification (in which case, a system of defaults will be used to determine the class name). |
java.util.List |
getComponentIds()
Returns an List of the String names of the IContainedComponent s for
this component. |
java.lang.String |
getDescription()
Returns the documentation for this component. |
java.util.List |
getInjectSpecifications()
Returns the list of InjectSpecification . |
IParameterSpecification |
getParameter(java.lang.String name)
Returns the specification of a parameter with the given name, or null if no such parameter exists. |
java.util.List |
getParameterNames()
Returns a List of of String names of all parameters. |
IPropertySpecification |
getPropertySpecification(java.lang.String name)
Returns the named IPropertySpecification , or null if no
such specification exist. |
java.util.List |
getPropertySpecificationNames()
Returns a sorted, immutable list of the names of all IPropertySpecification s. |
java.lang.String |
getPublicId()
Returns the XML Public Id for the specification file, or null if not applicable. |
java.util.Collection |
getRequiredParameters()
Returns an unordered collection of IParameterSpecification , for all parameters that
are required. |
java.util.Set |
getReservedParameterNames()
Returns a Set of Strings; the reserved parameter names for the component. |
org.apache.hivemind.Resource |
getSpecificationLocation()
|
boolean |
isDeprecated()
Returns true if the component is deprecated. |
boolean |
isPageSpecification()
Returns true if the specification is known to be a page specification and not a component specification. |
boolean |
isReservedParameterName(java.lang.String value)
Returns true if the value specified is in the reserved name list. |
void |
setAllowBody(boolean value)
|
void |
setAllowInformalParameters(boolean value)
|
void |
setComponentClassName(java.lang.String value)
|
void |
setDeprecated(boolean deprecated)
|
void |
setDescription(java.lang.String description)
Sets the documentation for this component. |
void |
setPageSpecification(boolean pageSpecification)
|
void |
setPublicId(java.lang.String publicId)
|
void |
setSpecificationLocation(org.apache.hivemind.Resource specificationLocation)
|
Methods inherited from interface org.apache.tapestry.util.IPropertyHolder |
getProperty, getPropertyNames, removeProperty, setProperty |
Methods inherited from interface org.apache.hivemind.LocationHolder |
setLocation |
Methods inherited from interface org.apache.hivemind.Locatable |
getLocation |
Method Detail |
public void addAsset(java.lang.String name, IAssetSpecification asset)
java.lang.IllegalArgumentException
- if the name already exists.public void addComponent(java.lang.String id, IContainedComponent component)
java.lang.IllegalArgumentException
- if the id is already defined.public void addParameter(IParameterSpecification spec)
java.lang.IllegalArgumentException
- if the name already exists.public boolean getAllowBody()
setAllowBody(boolean)
public boolean getAllowInformalParameters()
The default value is true.
setAllowInformalParameters(boolean)
public IAssetSpecification getAsset(java.lang.String name)
IAssetSpecification
with the given name, or null if no such specification
exists.
addAsset(String,IAssetSpecification)
public java.util.List getAssetNames()
List
of the String names of all assets, in alphabetical order
public IContainedComponent getComponent(java.lang.String id)
addComponent(String, IContainedComponent)
public java.lang.String getComponentClassName()
public java.util.List getComponentIds()
List
of the String names of the IContainedComponent
s for
this component.
addComponent(String, IContainedComponent)
public IParameterSpecification getParameter(java.lang.String name)
#addParameter(String, IParameterSpecification)
public java.util.Collection getRequiredParameters()
IParameterSpecification
, for all parameters that
are required. This includes only "real" parameters, not aliases.
public java.util.List getParameterNames()
#addParameter(String, IParameterSpecification)
public void setAllowBody(boolean value)
public void setAllowInformalParameters(boolean value)
public void setComponentClassName(java.lang.String value)
public void addBeanSpecification(java.lang.String name, IBeanSpecification specification)
java.lang.IllegalArgumentException
- if the bean already has a specification.public IBeanSpecification getBeanSpecification(java.lang.String name)
IBeanSpecification
for the given name, or null if not such specification
exists.
public java.util.Collection getBeanNames()
public void addReservedParameterName(java.lang.String value)
public boolean isReservedParameterName(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public java.lang.String getPublicId()
This method exists as a convienience for the Spindle plugin. A previous method used an arbitrary version string, the public id is more useful and less ambiguous.
public void setPublicId(java.lang.String publicId)
public boolean isPageSpecification()
public void setPageSpecification(boolean pageSpecification)
public org.apache.hivemind.Resource getSpecificationLocation()
public void setSpecificationLocation(org.apache.hivemind.Resource specificationLocation)
public void addPropertySpecification(IPropertySpecification spec)
public java.util.List getPropertySpecificationNames()
IPropertySpecification
s.
public IPropertySpecification getPropertySpecification(java.lang.String name)
IPropertySpecification
, or null if no
such specification exist.
addPropertySpecification(IPropertySpecification)
public void addInjectSpecification(InjectSpecification spec)
InjectSpecification
.
public java.util.List getInjectSpecifications()
InjectSpecification
. Will return an empty list if no
specifications have been added.
public boolean isDeprecated()
public void setDeprecated(boolean deprecated)
public java.util.Set getReservedParameterNames()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |