|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.generama.Plugin
org.generama.defaults.QDoxPlugin
org.objectweb.fractal.fraclet.Plugin
public class Plugin
Abstract Fractal plugin supporting Jelly and Velocity as template engines.
Field Summary | |
---|---|
protected static String |
OBJECT
|
protected boolean |
shouldGenerate
|
Fields inherited from class org.generama.defaults.QDoxPlugin |
---|
metadataProvider |
Fields inherited from class org.generama.Plugin |
---|
DONTEDIT, writerMapper |
Constructor Summary | |
---|---|
Plugin(JellyTemplateEngine jelly,
QDoxCapableMetadataProvider qdox,
WriterMapper writer)
Constructor used to generate XML files. |
|
Plugin(VelocityTemplateEngine velocity,
QDoxCapableMetadataProvider qdox,
WriterMapper writer)
Constructor used to generate Java or Property files. |
Method Summary | |
---|---|
protected void |
debug(String message)
Method used to abort the generation process. |
protected void |
failure(AbstractJavaEntity entity,
String message)
Method used to abort the generation process. |
protected Collection |
fields(JavaClass cls,
String doclet,
boolean all)
Provides a list of filtered fields. |
String |
getDestinationFilename(Object metadata)
|
String |
getDestinationPackage(Object metadata)
|
protected Collection |
methods(JavaClass cls,
String doclet,
boolean all)
Provides a list of filtered methods. |
protected void |
setDestination(String pkg,
String file,
String ext)
Provides the destination characteristics of the artifact. |
boolean |
shouldGenerate(Object obj)
|
protected static int |
toInt(boolean bool)
Converts a boolean to an array index. |
Methods inherited from class org.generama.defaults.QDoxPlugin |
---|
getMetadata, getMetadataProvider, setRestrictedpath |
Methods inherited from class org.generama.Plugin |
---|
assertTrue, getContextObjects, getDestdirFile, getEncoding, getOutputValidator, getPackageName, getWriterMapper, isEmpty, isMultioutput, isValidate, populateContextMap, preGenerate, setDestdir, setEncoding, setFileregex, setFilereplace, setMultioutput, setOutputValidator, setPackageregex, setPackagereplace, setValidate, start, stop |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String OBJECT
protected boolean shouldGenerate
Constructor Detail |
---|
public Plugin(JellyTemplateEngine jelly, QDoxCapableMetadataProvider qdox, WriterMapper writer)
jelly
- Jelly template engine used to generate artifacts.qdox
- QDox source code metadata provider.writer
- the output writer.public Plugin(VelocityTemplateEngine velocity, QDoxCapableMetadataProvider qdox, WriterMapper writer)
velocity
- Velocity template engine used to generate artifacts.qdox
- QDox source code metadata provider.writer
- the output writer.Method Detail |
---|
protected void debug(String message)
message
- the abort notification message.protected void failure(AbstractJavaEntity entity, String message)
message
- the abort notification message.public boolean shouldGenerate(Object obj)
shouldGenerate
in class QDoxPlugin
protected void setDestination(String pkg, String file, String ext)
pkg
- the packagefile
- the fileext
- the extensionpublic String getDestinationPackage(Object metadata)
getDestinationPackage
in class Plugin
public String getDestinationFilename(Object metadata)
getDestinationFilename
in class Plugin
protected Collection fields(JavaClass cls, String doclet, boolean all)
cls
- the java class source file parsed.doclet
- the name of the doclet to retrieve.all
- performs the search recursively.
protected Collection methods(JavaClass cls, String doclet, boolean all)
cls
- the java class source file parsed.doclet
- the name of the doclet to retrieve.all
- performs the search recursively.
protected static int toInt(boolean bool)
bool
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |