|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for the Specification for a library.
ApplicationSpecification
is a specialized kind of library.
Method Summary | |
void |
addExtensionSpecification(java.lang.String name,
IExtensionSpecification extension)
Adds another extension specification. |
boolean |
checkExtension(java.lang.String name)
Returns true if the named extension exists (or can be instantiated), returns false if the named extension has no specification. |
java.lang.String |
getComponentSpecificationPath(java.lang.String type)
|
java.util.List |
getComponentTypes()
Returns the simple types of all components defined in this library. |
java.lang.String |
getDescription()
Returns the documentation for this library.. |
java.lang.Object |
getExtension(java.lang.String name)
Returns an instantiated extension. |
java.lang.Object |
getExtension(java.lang.String name,
java.lang.Class typeConstraint)
Returns an instantiated extension, performing a check to ensure that the extension is a subtype of the given class (or extends the given interface). |
java.util.List |
getExtensionNames()
Returns a sorted List of the names of all extensions. |
IExtensionSpecification |
getExtensionSpecification(java.lang.String name)
Returns the named IExtensionSpecification, or null if it doesn't exist. |
java.util.Map |
getExtensionSpecifications()
Returns a Map of extensions; key is extension name, value is IExtensionSpecification . |
java.util.List |
getLibraryIds()
Returns a sorted list of library ids (or the empty list, but not null). |
java.lang.String |
getLibrarySpecificationPath(java.lang.String id)
Returns the specification path (within the classpath) for an embedded library, or null if no such library has been defined. |
java.util.List |
getPageNames()
Returns a sorted list of page names explicitly defined by this library, or an empty list (but not null). |
java.lang.String |
getPageSpecificationPath(java.lang.String name)
|
java.lang.String |
getPublicId()
|
java.lang.String |
getServiceClassName(java.lang.String name)
Deprecated. to be removed in release 4.1 |
java.util.List |
getServiceNames()
Deprecated. to be removed in release 4.1 |
org.apache.hivemind.Resource |
getSpecificationLocation()
Returns the location from which the specification was read. |
void |
instantiateImmediateExtensions()
Invoked after the entire specification has been constructed to instantiate any extensions marked immediate. |
void |
setComponentSpecificationPath(java.lang.String type,
java.lang.String path)
|
void |
setDescription(java.lang.String description)
Sets the documentation for this library. |
void |
setLibrarySpecificationPath(java.lang.String id,
java.lang.String path)
Sets the specification path for an embedded library. |
void |
setPageSpecificationPath(java.lang.String name,
java.lang.String path)
|
void |
setPublicId(java.lang.String value)
|
void |
setServiceClassName(java.lang.String name,
java.lang.String className)
Deprecated. To be removed in release 4.1. |
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 java.lang.String getLibrarySpecificationPath(java.lang.String id)
public void setLibrarySpecificationPath(java.lang.String id, java.lang.String path)
java.lang.IllegalArgumentException
- if a library with the given id already existspublic java.util.List getLibraryIds()
public java.lang.String getPageSpecificationPath(java.lang.String name)
public void setPageSpecificationPath(java.lang.String name, java.lang.String path)
public java.util.List getPageNames()
public void setComponentSpecificationPath(java.lang.String type, java.lang.String path)
public java.lang.String getComponentSpecificationPath(java.lang.String type)
public java.util.List getComponentTypes()
public java.lang.String getServiceClassName(java.lang.String name)
java.lang.UnsupportedOperationException
- alwayspublic java.util.List getServiceNames()
public void setServiceClassName(java.lang.String name, java.lang.String className)
java.lang.UnsupportedOperationException
- alwayspublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
public java.util.Map getExtensionSpecifications()
IExtensionSpecification
. May return null. The returned Map
is immutable.
public void addExtensionSpecification(java.lang.String name, IExtensionSpecification extension)
public java.util.List getExtensionNames()
public IExtensionSpecification getExtensionSpecification(java.lang.String name)
public java.lang.Object getExtension(java.lang.String name)
java.lang.IllegalArgumentException
- if no extension specification exists for the given name.public java.lang.Object getExtension(java.lang.String name, java.lang.Class typeConstraint)
java.lang.IllegalArgumentException
- if no extension specification exists for the given name, or if the extension
fails the type check.public boolean checkExtension(java.lang.String name)
public void instantiateImmediateExtensions()
public java.lang.String getPublicId()
public void setPublicId(java.lang.String value)
public org.apache.hivemind.Resource getSpecificationLocation()
public void setSpecificationLocation(org.apache.hivemind.Resource specificationLocation)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |