|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateEngine
xdoclet.template.TemplateParser
Subclass of Template Engine that do not generate anything but only parse the document. The TagHandlers have a callback entry to this method to set in it anything they want to. This class was introduced for parsing .j files and return a list of merge files needed for the generation. The timestamp checking can then verify all files involved in a generation and bypass the generation if -nothing has changed-.
Field Summary |
Fields inherited from class xdoclet.template.TemplateEngine |
docEncoding, out, output, TAG_MAPPINGS_FILE, XDOCLET_HEAD, XDOCLET_HEAD_LEN, XDOCLET_PREFIX, XDOCLET_TAIL, XDOCLET_TAIL_LEN |
Constructor Summary | |
protected |
TemplateParser()
Initialize the Template Engine. |
Method Summary | |
void |
addMergeFile(String file)
Callback by the MergeTagsHandler to give the parser the list of merge files involved. |
void |
generate(String template)
In this class, this method does not -generate- anything but only parse the files. |
String[] |
getMergeFiles()
Return the list of merge files involved in the generation. |
static TemplateParser |
getParserInstance()
Gets the ParserInstance attribute of the TemplateParser class |
TemplateTagHandler |
getTagHandlerFor(String prefix)
Get the tag handler for the prefix. |
boolean |
hasMergeFile(String file)
Callback by the MergeTagsHandler to know if a merge file has already been taken into account. |
protected Object |
invoke(Method m,
Object cmdImplProvider,
Object[] params1)
Describe what the method does |
protected void |
invokeContentMethod(String cmd,
Properties attributes,
String template,
int i)
Describe what the method does |
void |
start()
A utility method used for generating the dest_file based on template_file template file. |
Methods inherited from class xdoclet.template.TemplateEngine |
getCurrentLineNum, getEngineInstance, getLineNumber, getNamespaces, getOutput, getTemplateURL, handleTag, invokeMethod, outputOf, print, setCurrentLineNum, setDocEncoding, setOutput, setTagHandlerFor, setTemplateURL, setWriter, setXJavaDoc, skipWhitespace |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected TemplateParser()
Method Detail |
public static TemplateParser getParserInstance()
public TemplateTagHandler getTagHandlerFor(String prefix) throws TemplateException
TemplateEngine
getTagHandlerFor
in class TemplateEngine
prefix
- The prefix that the tag handler is mapped to
TemplateException
- If there is no tag handler class for the prefix specified.public String[] getMergeFiles()
public void start() throws TemplateException
start
in class TemplateEngine
TemplateException
- Description of Exceptionpublic void generate(String template) throws TemplateException
generate
in class TemplateEngine
template
- Description of Parameter
TemplateException
- Description of ExceptionTemplateEngine.outputOf(java.lang.String)
public void addMergeFile(String file)
file
- one merge file involvedpublic boolean hasMergeFile(String file)
file
-
protected void invokeContentMethod(String cmd, Properties attributes, String template, int i) throws TemplateException
invokeContentMethod
in class TemplateEngine
cmd
- Describe what the parameter doesattributes
- Describe what the parameter doestemplate
- Describe what the parameter doesi
- Describe what the parameter does
TemplateException
- Describe the exceptionTemplateEngine.invokeMethod(java.lang.String,java.lang.Object[],java.lang.Object[],java.lang.String,int)
protected Object invoke(Method m, Object cmdImplProvider, Object[] params1) throws InvocationTargetException, IllegalAccessException, TemplateException
invoke
in class TemplateEngine
m
- Describe what the parameter doescmdImplProvider
- Describe what the parameter doesparams1
- Describe what the parameter does
InvocationTargetException
- Describe the exception
IllegalAccessException
- Describe the exception
TemplateException
- Describe the exception
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |