|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ILibrarySpecification
Interface for the Specification for a library. ApplicationSpecification
is a specialized kind of library.
Method Summary | |
---|---|
void |
addExtensionSpecification(String name,
IExtensionSpecification extension)
Adds another extension specification. |
boolean |
checkExtension(String name)
Returns true if the named extension exists (or can be instantiated), returns false if the named extension has no specification. |
String |
getComponentSpecificationPath(String type)
|
List |
getComponentTypes()
Returns the simple types of all components defined in this library. |
String |
getDescription()
Returns the documentation for this library.. |
Object |
getExtension(String name)
Returns an instantiated extension. |
Object |
getExtension(String name,
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). |
List |
getExtensionNames()
Returns a sorted List of the names of all extensions. |
IExtensionSpecification |
getExtensionSpecification(String name)
Returns the named IExtensionSpecification, or null if it doesn't exist. |
Map |
getExtensionSpecifications()
Returns a Map of extensions; key is extension name, value is IExtensionSpecification . |
List |
getLibraryIds()
Returns a sorted list of library ids (or the empty list, but not null). |
String |
getLibrarySpecificationPath(String id)
Returns the specification path (within the classpath) for an embedded library, or null if no such library has been defined. |
List |
getPageNames()
Returns a sorted list of page names explicitly defined by this library, or an empty list (but not null). |
String |
getPageSpecificationPath(String name)
|
String |
getPublicId()
|
IResourceResolver |
getResourceResolver()
|
String |
getServiceClassName(String name)
|
List |
getServiceNames()
Returns a sorted list of service names (or an empty list, but not null). |
IResourceLocation |
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(String type,
String path)
|
void |
setDescription(String description)
Sets the documentation for this library. |
void |
setLibrarySpecificationPath(String id,
String path)
Sets the specification path for an embedded library. |
void |
setPageSpecificationPath(String name,
String path)
|
void |
setPublicId(String value)
|
void |
setResourceResolver(IResourceResolver resolver)
|
void |
setServiceClassName(String name,
String className)
|
void |
setSpecificationLocation(IResourceLocation specificationLocation)
|
Methods inherited from interface org.apache.tapestry.util.IPropertyHolder |
---|
getProperty, getPropertyNames, removeProperty, setProperty |
Methods inherited from interface org.apache.tapestry.ILocationHolder |
---|
setLocation |
Methods inherited from interface org.apache.tapestry.ILocatable |
---|
getLocation |
Method Detail |
---|
String getLibrarySpecificationPath(String id)
void setLibrarySpecificationPath(String id, String path)
IllegalArgumentException
- if a library with the given
id already existsList getLibraryIds()
String getPageSpecificationPath(String name)
void setPageSpecificationPath(String name, String path)
List getPageNames()
void setComponentSpecificationPath(String type, String path)
String getComponentSpecificationPath(String type)
List getComponentTypes()
String getServiceClassName(String name)
List getServiceNames()
void setServiceClassName(String name, String className)
String getDescription()
void setDescription(String description)
Map getExtensionSpecifications()
IExtensionSpecification
.
May return null. The returned Map is immutable.
void addExtensionSpecification(String name, IExtensionSpecification extension)
List getExtensionNames()
IExtensionSpecification getExtensionSpecification(String name)
Object getExtension(String name)
IllegalArgumentException
- if no extension specification exists for the
given name.Object getExtension(String name, Class typeConstraint)
IllegalArgumentException
- if no extension specification exists for
the given name, or if the extension fails the type check.boolean checkExtension(String name)
void instantiateImmediateExtensions()
IResourceResolver getResourceResolver()
void setResourceResolver(IResourceResolver resolver)
String getPublicId()
void setPublicId(String value)
IResourceLocation getSpecificationLocation()
void setSpecificationLocation(IResourceLocation specificationLocation)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |