xdoclet.tagshandler
public class MergeTagsHandler extends XDocletTagSupport
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
MergeTagsHandler() |
Modifier and Type | Method and Description |
---|---|
protected void |
generateFileUsingTemplate(java.lang.String dest_file,
java.lang.String templateFileName)
A utility method used for generating the dest_file based on template_file template file.
|
protected void |
generateUsingMergedFile(java.lang.String mergeFile,
java.lang.String contents)
Processes the file specified in merge_file_pattern that has the text content contents.
|
protected java.lang.String |
getMergeFileContents(java.lang.String mergeFilePattern)
A utility method used for merging a file used by
|
void |
ifMergeFileExists(java.lang.String template,
java.util.Properties attributes)
Evaluates the body if the file exists specified by the "file" attribute.
|
void |
merge(java.lang.String template,
java.util.Properties attributes)
Merge contents of the file designated by the file parameter and evaluates the body if the file is not found.
|
delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
getXJavaDoc, setXJavaDoc
public void ifMergeFileExists(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
public void merge(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- XDocletException if something goes wrongprotected java.lang.String getMergeFileContents(java.lang.String mergeFilePattern)
mergeFilePattern
- The exact file name or a string that has a {0} in it. {0} is substituted by symbolic
class name of current class.merge(java.lang.String,java.util.Properties)
,
PackageTagsHandler.packageNameAsPathFor(xjavadoc.XPackage)
,
ClassTagsHandler.symbolicClassName()
,
FileManager
protected void generateUsingMergedFile(java.lang.String mergeFile, java.lang.String contents) throws XDocletException
mergeFile
- The file to be mergedcontents
- Description of ParameterXDocletException
- Description of ExceptionTemplateEngine.setTemplateURL(java.net.URL)
protected void generateFileUsingTemplate(java.lang.String dest_file, java.lang.String templateFileName) throws XDocletException
dest_file
- the path to the destination file prepended by value of the destDir configuration
parameter.templateFileName
- the template file nameXDocletException
- Description of Exception