public interface IComponentSpecification extends IPropertyHolder, org.apache.hivemind.LocationHolder, org.apache.hivemind.Locatable
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
Modifier and Type | Method and Description |
---|---|
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) |
getProperty, getPropertyNames, removeProperty, setProperty
void addAsset(java.lang.String name, IAssetSpecification asset)
java.lang.IllegalArgumentException
- if the name already exists.void addComponent(java.lang.String id, IContainedComponent component)
java.lang.IllegalArgumentException
- if the id is already defined.void addParameter(IParameterSpecification spec)
java.lang.IllegalArgumentException
- if the name already exists.boolean getAllowBody()
setAllowBody(boolean)
boolean getAllowInformalParameters()
The default value is true.
setAllowInformalParameters(boolean)
IAssetSpecification getAsset(java.lang.String name)
IAssetSpecification
with the given name, or null if no such specification
exists.addAsset(String,IAssetSpecification)
java.util.List getAssetNames()
List
of the String names of all assets, in alphabetical orderIContainedComponent getComponent(java.lang.String id)
java.lang.String getComponentClassName()
java.util.List getComponentIds()
List
of the String names of the IContainedComponent
s for
this component.IParameterSpecification getParameter(java.lang.String name)
#addParameter(String, IParameterSpecification)
java.util.Collection getRequiredParameters()
IParameterSpecification
, for all parameters that
are required. This includes only "real" parameters, not aliases.java.util.List getParameterNames()
#addParameter(String, IParameterSpecification)
void setAllowBody(boolean value)
void setAllowInformalParameters(boolean value)
void setComponentClassName(java.lang.String value)
void addBeanSpecification(java.lang.String name, IBeanSpecification specification)
java.lang.IllegalArgumentException
- if the bean already has a specification.IBeanSpecification getBeanSpecification(java.lang.String name)
IBeanSpecification
for the given name, or null if not such specification
exists.java.util.Collection getBeanNames()
void addReservedParameterName(java.lang.String value)
boolean isReservedParameterName(java.lang.String value)
java.lang.String getDescription()
void setDescription(java.lang.String description)
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.
void setPublicId(java.lang.String publicId)
boolean isPageSpecification()
void setPageSpecification(boolean pageSpecification)
org.apache.hivemind.Resource getSpecificationLocation()
void setSpecificationLocation(org.apache.hivemind.Resource specificationLocation)
void addPropertySpecification(IPropertySpecification spec)
java.util.List getPropertySpecificationNames()
IPropertySpecification
s.IPropertySpecification getPropertySpecification(java.lang.String name)
IPropertySpecification
, or null if no
such specification exist.addPropertySpecification(IPropertySpecification)
void addInjectSpecification(InjectSpecification spec)
InjectSpecification
.java.util.List getInjectSpecifications()
InjectSpecification
. Will return an empty list if no
specifications have been added.boolean isDeprecated()
void setDeprecated(boolean deprecated)
java.util.Set getReservedParameterNames()