|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An abstraction layer for metadata. A MetadataProvider object provides a Collection of objects to use during code generation, and also defines some necessary methods for accessing additional information like package name and the String to replace in {0} style destination file names.
This makes it possible to use other sources/APIs than xjavadoc to provide metadata that a plugin requires.
Method Summary | |
void |
cleanup()
Frees any resources and does any other necessary work before shutting down. |
Collection |
createMetadataCollection()
Returns a Collection of objects that should be used as basis for code generation. |
String |
getFilenameSubstitutionValue(Object o)
Returns the string that will be replaced in the {0} part of the file name. |
String |
getPackageName(Object o)
Returns the package name that will be used to determine the file name. |
void |
setClasspath(String classpath)
Sets the classpath. |
Method Detail |
public Collection createMetadataCollection() throws XDocletException
XDocletException
public String getFilenameSubstitutionValue(Object o) throws XDocletException
o
- the object the substitution string should be derived from.
XDocletException
public String getPackageName(Object o)
o
- the object from which the package name is derived.
public void cleanup() throws XDocletException
XDocletException
public void setClasspath(String classpath) throws XDocletException
XDocletException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |