xdoclet.tagshandler
public class MergeTagsHandler extends XDocletTagSupport
Version: $Revision: 1.13 $
UNKNOWN: Oct 15, 2001 namespace = "Merge"
Method Summary | |
---|---|
protected void | generateFileUsingTemplate(String dest_file, String templateFileName)
A utility method used for generating the dest_file based on template_file template file.
|
protected void | generateUsingMergedFile(String mergeFile, String contents)
Processes the file specified in merge_file_pattern that has the text content contents. |
protected String | getMergeFileContents(String mergeFilePattern)
A utility method used for merging a file used by |
void | ifMergeFileExists(String template, Properties attributes)
Evaluates the body if the file exists specified by the "file" attribute.
|
void | merge(String template, Properties attributes)
Merge contents of the file designated by the file parameter and evaluates the body if the file is not found. |
Parameters: dest_file the path to the destination file prepended by value of the destDir configuration parameter. templateFileName the template file name
Throws: XDocletException Description of Exception
Parameters: mergeFile The file to be merged contents Description of Parameter
Throws: XDocletException Description of Exception
See Also: setTemplateURL
Parameters: mergeFilePattern The exact file name or a string that has a {0} in it. {0} is substituted by symbolic class name of current class.
Returns: The content of the text file.
See Also: MergeTagsHandler PackageTagsHandler symbolicClassName FileManager
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block" name = "file" optional = "false" description = "The path to the file to be merged. The * value of this parameter can have {0} in it, if so {0} is replaced with the current class name and system * searches for the file in in mergeDir+packageName directory. {0} is for cases where you want to define and * merge a file per each class."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException XDocletException if something goes wrong
UNKNOWN: type = "block" name = "file" optional = "false" description = "The path to the file to be merged. The * value of this parameter can have {0} in it, if so {0} is replaced with the current class name and system * searches for the file in in mergeDir+packageName directory. {0} is for cases where you want to define and * merge a file per each class." name = "generateMergedFile" values = "true,false" description = "If true then process the * merged file also, otherwise only merge it and do not process it. True if the default."