Alphabetical Index

A B C D E F G H I J L M N O P R S T V W X

A

Allows to set configuration parameters that will be included in the element as attribute value pair.
Specifies a configuration parameter for the subtask.
addConfiguredXMLCatalog(XMLCatalog) - method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
add an XMLCatalog as a nested element; optional.
addFileset(FileSet) - method in class xdoclet.DocletTask
Ant's <fileset> definition.
addMergeFile(String) - method in class xdoclet.template.TemplateParser
Callback by the MergeTagsHandler to give the parser the list of merge files involved.
addOfType(String) - method in class xdoclet.TemplateSubTask
Substitutes the package of the generated files.
Substitutes the package of the generated files.
addSubTask(String,String,String) - method in class xdoclet.loader.XDocletModule
addSubTask(xdoclet.SubTask) - method in class xdoclet.DocletTask
Generic subtask.
addTagHandler(String,String) - method in class xdoclet.loader.XDocletModule
Generic subtask for processing a user-supplied template.
Generic subtask for processing a user-supplied template, to generate an XML document.
AMBIGUOUS_SUBTASK_DEFINITION - static field in class xdoclet.XDocletMessages
Extracts properties from Ant.
AntPropertyTagsHandler(Hashtable) - constructor for class xdoclet.ant.AntPropertyTagsHandler
Describe what the AntPropertyTagsHandler constructor does
ATTRIBUTE_NOT_PRESENT_ERROR - static field in class xdoclet.XDocletMessages
ATTRIBUTE_NOT_SET_ERROR - static field in class xdoclet.tagshandler.XDocletTagshandlerMessages
ATTRIBUTE_NOT_SUPPORTED - static field in class xdoclet.XDocletMessages

B

BAD_GETTEXT_DOC_TYPE - static field in class xdoclet.XDocletMessages
BAD_PRGELEMDOC_TYPE - static field in class xdoclet.XDocletMessages
BAD_TAGVALUE_TYPE - static field in class xdoclet.XDocletMessages
BAD_XDOCLET_XML - static field in class xdoclet.loader.LoaderMessages

C

capitalize(String) - static method in class xdoclet.ConfigParamIntrospector
Describe what the method does
CHECK_CLASS_FAILED - static field in class xdoclet.XDocletMessages
checkClass(String) - method in class xdoclet.DocletTask
Throws BuildException if a specific class is not on the CP.
checkForWrap(String) - method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
A utility method used by firstSentenceDescription to replace end of line by space.
CLASS_CAST_EXCEPTION - static field in class xdoclet.XDocletMessages
CLASS_NOT_FOUND - static field in class xdoclet.XDocletMessages
CLASS_NOT_FOUND_EXCEPTION - static field in class xdoclet.XDocletMessages
CLASS_TAG_EXPECTED - static field in class xdoclet.XDocletMessages
CLASS_TAG_PARAMETER_EXPECTED - static field in class xdoclet.XDocletMessages
classComment(Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
The comment for the current class.
classCommentTags(Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
The javadoc comment tags for the current class (plus xdoclet-generated).
classCommentText(Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
The text of the javadoc comment for the current class.
classLoader - field in class xdoclet.util.XmlValidator
className - field in class xdoclet.loader.TagHandlerDefinition
className() - method in class xdoclet.tagshandler.ClassTagsHandler
Returns the not-fully-qualified name of the current class without the package name.
classOf(String) - method in class xdoclet.tagshandler.ClassTagsHandler
Returns the not-full-qualified name of the full-qualified class name specified in the body of this tag.
ClassTagsHandler - class xdoclet.tagshandler.ClassTagsHandler
Tags relating to classes being processed and class-level attributes.
classTagValue(Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Iterates over all class tags with the specified tagName and evaluates the body of the tag for each class tag.
classTagValueMatch(Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Sets the value of match variable.
close() - method in class xdoclet.template.PrettyPrintWriter
Closes the output stream and writes the last line.
comment(String) - method in class xdoclet.tagshandler.CommentTagsHandler
This tag simply output nothing.
CommentTagsHandler - class xdoclet.tagshandler.CommentTagsHandler
Allows to set configuration parameters that will be included in the element as attribute value pair.
The following input

<configParam name="foo" value="bar"/>

will give

<foo>bar</foo>

configParameterValue(Properties) - method in class xdoclet.tagshandler.ConfigTagsHandler
Returns the values of a configuration parameter with the name paramName.
Used by DocletTask.
ConfigTagsHandler - class xdoclet.tagshandler.ConfigTagsHandler
constructorComment(Properties) - method in class xdoclet.tagshandler.ConstructorTagsHandler
The comment for the current constructor.
constructorName(Properties) - method in class xdoclet.tagshandler.ConstructorTagsHandler
Returns the name of the current constructor.
constructorTagValue(Properties) - method in class xdoclet.tagshandler.ConstructorTagsHandler
Iterates over all constructor tags with the specified tagName for the current constructor probably inside of a forAllConstructorTags body.
CONTEXT_READ_ERROR - static field in class xdoclet.XDocletMessages
CONTEXT_WRITE_ERROR - static field in class xdoclet.XDocletMessages
Describe what the method does
Describe what the method does
Describe what the method does
COULDNT_CONF_XML_PARSER - static field in class xdoclet.XDocletMessages
COULDNT_FIND_BEAN - static field in class xdoclet.XDocletMessages
COULDNT_FIND_DTD - static field in class xdoclet.XDocletMessages
COULDNT_INIT_XML_PARSER - static field in class xdoclet.XDocletMessages
COULDNT_INSTANTIATE_SUBTASK - static field in class xdoclet.XDocletMessages
COULDNT_LOAD_DTD - static field in class xdoclet.XDocletMessages
COULDNT_LOAD_LOCAL_DTD - static field in class xdoclet.XDocletMessages
COULDNT_LOAD_XML_FILE - static field in class xdoclet.XDocletMessages
CREATE_TASK_ERROR - static field in class xdoclet.XDocletMessages
createDTD() - method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
Create a DTD location record; optional.
createDynamicElement(String) - method in class xdoclet.DocletTask
currentClassTag - static field in class xdoclet.DocletSupport
currentConstructorName() - method in class xdoclet.tagshandler.ConstructorTagsHandler
Returns the current constructor name.
currentFieldTag - static field in class xdoclet.DocletSupport
currentMethodName() - method in class xdoclet.tagshandler.MethodTagsHandler
Returns the current method name.
currentMethodParameter - static field in class xdoclet.tagshandler.ParameterTagsHandler
The current method's current parameter.
currentMethodParamTag - static field in class xdoclet.tagshandler.ParameterTagsHandler
The currentMethodParamTag holds the current ParamTag corresponding to the current Parameter.
currentMethodTag - static field in class xdoclet.DocletSupport
The current Tag.
currentName - field in class xdoclet.tagshandler.ParameterTagsHandler
currentName() - method in class xdoclet.tagshandler.ParameterTagsHandler
return name of parameter currently being iterated - ugly hack...
currentToken - static field in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
The current token.
currentToken(Properties) - method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Returns current token inside forAllClassTagTokens.

D

dateFormatter - static field in class xdoclet.tagshandler.ClassTagsHandler
Used for setting the timestamp for xdoclet-generated marker in generated files.
DEFAULT_XML_READER_CLASSNAME - static field in class xdoclet.util.XmlValidator
The crimson implementation is shipped with ant.
delimit(String,Properties) - static method in class xdoclet.XDocletTagSupport
DO_NOT_EDIT - static field in class xdoclet.XDocletMessages
docEncoding - field in class xdoclet.template.TemplateEngine
Describe what the DocletContext constructor does
DocletSupport() - constructor for class xdoclet.DocletSupport
DocletTask - class xdoclet.DocletTask
A base class for all Tasks.
DocletTask() - constructor for class xdoclet.DocletTask
DocletUtil - class xdoclet.util.DocletUtil
doFileOperations() - method in class xdoclet.ant.ReplaceCopy
Overridden doFileOperations() as Ant suggests.
DONE_REGISTERING_MODULES - static field in class xdoclet.loader.LoaderMessages
DUPLICATED_TAG - static field in class xdoclet.XDocletMessages

E

engineFinished() - method in class xdoclet.TemplateSubTask
Describe what the method does
engineFinished() - method in class xdoclet.XmlSubTask
Describe what the method does
engineStarted() - method in class xdoclet.TemplateSubTask
Describe what the method does
error(SAXParseException) - method in class xdoclet.util.XmlValidator
Called by parser if a error occurs
ERROR_CREATING_TEMPLATEENGINE - static field in class xdoclet.ant.XDocletAntMessages
EXCEPTION_READING_MERGE_FILE - static field in class xdoclet.util.XDocletUtilMessages
exceptionList(Properties) - method in class xdoclet.tagshandler.ConstructorTagsHandler
Iterates over all exceptions thrown by the current constructor and returns a string containing definition of all those exceptions.
exceptionList(Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Iterates over all exceptions thrown by the current method and returns a string containing definition of all those exceptions.
Describe what the method does
execute() - method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
execute() - method in class xdoclet.SubTask
Called to start execution of the sub-task.
execute() - method in class xdoclet.TemplateSubTask
Describe what the method does
Evaluate the current block, and then restore the current constructor before continuing.
Evaluate the current block, and then restore the current method before continuing.
expandClassName(String,Properties) - static method in class xdoclet.XDocletTagSupport
EXTENT_TYPE_HIERARCHY - static field in class xdoclet.TemplateSubTask.ExtentTypes
EXTENT_TYPE_SUPERCLASS - static field in class xdoclet.TemplateSubTask.ExtentTypes
extractExtentType(String) - static method in class xdoclet.tagshandler.TypeTagsHandler
Return the integer constant based on the extent_str.

F

FAILED_TO_COPY - static field in class xdoclet.ant.XDocletAntMessages
fieldComment(Properties) - method in class xdoclet.tagshandler.FieldTagsHandler
The comment for the current field.
fieldName() - method in class xdoclet.tagshandler.FieldTagsHandler
Returns the name of the current field.
FieldTagsHandler - class xdoclet.tagshandler.FieldTagsHandler
fieldTagValue(Properties) - method in class xdoclet.tagshandler.FieldTagsHandler
Iterates over all field tags with the specified tagName for the current field probably inside of a forAllFieldTags body.
fieldType() - method in class xdoclet.tagshandler.FieldTagsHandler
Returns the type of the current field.
FileManager - class xdoclet.util.FileManager
A utility class for handling common filing operations.
Describe what the method does
findModules() - static method in class xdoclet.loader.ModuleFinder
Returns a List of XDocletModule objects
firstSentenceDescription(Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Return first sentence of standard javadoc of current class.
Return standard javadoc of current constructor.
firstSentenceDescriptionOfCurrentField() - method in class xdoclet.tagshandler.FieldTagsHandler
Return standard javadoc of current field.
Describe what the method does
firstSentenceDescriptionOfCurrentMethod() - method in class xdoclet.tagshandler.MethodTagsHandler
Return standard javadoc of current method.
FOR_CLASS - static field in class xdoclet.XDocletTagSupport
FOR_CONSTRUCTOR - static field in class xdoclet.XDocletTagSupport
FOR_FIELD - static field in class xdoclet.XDocletTagSupport
FOR_METHOD - static field in class xdoclet.XDocletTagSupport
Loops through all constructors for all classes after first sorting all the constructors.
forAllClasses(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Iterates over all classes loaded by xjavadoc and evaluates the body of the tag for each class.
forAllClassMethods(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Loops through all methods for all classes after first sorting all the methods.
forAllClassTags(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Iterates over all tags of current class with the name tagName and evaluates the body of the tag for each method.
forAllClassTagTokens(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Iterates over all tokens in specified class tag with the name tagName and evaluates the body for every token.
forAllConfigParameters(String,Properties) - method in class xdoclet.tagshandler.ConfigTagsHandler
Evaluate the body for all configuration parameters with the name paramName.
forAllConstructorParams(String) - method in class xdoclet.tagshandler.ParameterTagsHandler
Iterates over all parameters of current constructor and evaluates the body of the tag for each method.
Iterates over all constructors of current class and evaluates the body of the tag for each constructor.
Iterates over all tags of current constructor and evaluates the body of the tag for each constructor.
Iterates over all tokens in current constructor tag with the name tagName and evaluates the body for every token.
forAllDistinctClassTags(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Iterates over all tags named according to tagName in a non-duplicated manner.
Iterates over all tags named according to tagName in a non-duplicated manner.
forAllFields(String,Properties) - method in class xdoclet.tagshandler.FieldTagsHandler
Iterates over all fields of current class and evaluates the body of the tag for each field.
forAllFieldTags(String,Properties) - method in class xdoclet.tagshandler.FieldTagsHandler
Iterates over all tags of current field and evaluates the body of the tag for each field.
forAllFieldTagTokens(String,Properties) - method in class xdoclet.tagshandler.FieldTagsHandler
Iterates over all tokens in current field tag with the name tagName and evaluates the body for every token.
Describe what the method does
Describe what the method does
forAllMethodParams(String) - method in class xdoclet.tagshandler.ParameterTagsHandler
Iterates over all parameters of current method and evaluates the body of the tag for each method.
forAllMethods(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Iterates over all methods of current class and evaluates the body of the tag for each method.
forAllMethodTags(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Iterates over all tags of current method and evaluates the body of the tag for each method.
forAllMethodTagTokens(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Iterates over all tokens in current method tag with the name tagName and evaluates the body for every token.
forAllPackages(String,Properties) - method in class xdoclet.tagshandler.PackageTagsHandler
Iterates over all packages loaded by XJavadoc.
Gets the value of the parameter specified by paramName of current tag, and assuming the value has the format of a typical method definition extracts of parameter types out of it and evaluates the body for each parameter type.
Evaluates the body block for each property of current mbean.You may set whether superclasses are examined also with the superclass attribute.
fullClassName() - method in class xdoclet.tagshandler.ClassTagsHandler
Returns the full-qualified name of the current class.
fullSuperclassName() - method in class xdoclet.tagshandler.ClassTagsHandler
Returns the full-qualified name of the superclass of the current class.
fullTransformedClassName() - method in class xdoclet.tagshandler.ClassTagsHandler
Returns the fully-qualified transformed name of the current class with package name.

G

generate(String) - method in class xdoclet.template.TemplateEngine
The main template parsing/processing/running logic.
generate(String) - method in class xdoclet.template.TemplateParser
In this class, this method does not -generate- anything but only parse the files.
generate(String) - method in class xdoclet.XDocletTagSupport
GENERATED_BY_XDOCLET - static field in class xdoclet.XDocletMessages
GENERATED_XML_INVALID - static field in class xdoclet.util.XDocletUtilMessages
generateFileUsingTemplate(String,String) - method in class xdoclet.tagshandler.MergeTagsHandler
A utility method used for generating the dest_file based on template_file template file.
generateForClass(XClass) - method in class xdoclet.TemplateSubTask
Processed template for clazz and generates output file for clazz.
generateUsingMergedFile(String,String) - method in class xdoclet.tagshandler.MergeTagsHandler
Processes the file specified in merge_file_pattern that has the text content contents.
GENERATING_SOMETHING - static field in class xdoclet.XDocletMessages
Verify if the generation is needed for Java files and Xml files based templates.
Describe what the GenerationManager constructor does
getAcceptInterfaces() - method in class xdoclet.TemplateSubTask
getActiveSubTask() - method in class xdoclet.DocletContext
Gets the ActiveSubTask attribute of the DocletContext object
getAddedTags() - method in class xdoclet.DocletContext
getAddedTags() - method in class xdoclet.DocletTask
getAllClasses() - static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Utility method to get classes for iteration used by various methods.
getBaseDir() - method in class xdoclet.XDocletFacade
getCapitalizedFieldName() - method in class xdoclet.tagshandler.FieldTagsHandler
Returns the capitalized name of the current field.
getClassNameFor(XClass) - static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Returns the not-full-qualified name of the specified class without the package name.
getClassNameFor(XClass) - static method in class xdoclet.tagshandler.ClassTagsHandler
Returns the not-full-qualified name of the specified class without the package name.
getClasspath() - static method in class xdoclet.loader.ModuleFinder
getConfigParam(String) - method in class xdoclet.DocletContext
Gets the ConfigParam attribute of the DocletContext object
getConfigParameter(String) - method in class xdoclet.tagshandler.ConfigTagsHandler
Returns the value for the specified configuration parameter.
getConfigParams() - method in class xdoclet.DocletTask
Gets the ConfigParams attribute of the DocletTask object
getConfigParams() - method in class xdoclet.SubTask
Gets the ConfigParams attribute of the SubTask object
getConfigParams(List) - method in class xdoclet.DocletTask
Gets the ConfigParams attribute of the DocletTask object
getConfigParamsAsMap() - method in class xdoclet.DocletTask
getConfigParamsAsMap() - method in class xdoclet.SubTask
getContext() - method in class xdoclet.SubTask
A utility method that deleges the call to DocletContext.getSingleInstance().
getCurrentClass() - method in class xdoclet.DocletSupport
Peeks and return the current class from top of currentClassStack stack.
getCurrentClass() - static method in class xdoclet.XDocletTagSupport
Provides the current class in the XDoclet build, or null if there is no current class.
getCurrentClassTag() - static method in class xdoclet.DocletSupport
Gets the CurrentClassTag attribute of the DocletSupport class
getCurrentClassTag() - static method in class xdoclet.XDocletTagSupport
getCurrentConfigParamIndex() - static method in class xdoclet.tagshandler.ConfigTagsHandler
Gets the CurrentConfigParamIndex attribute of the ConfigTagsHandler class
getCurrentConstructor() - method in class xdoclet.DocletSupport
Returns current constructor.
getCurrentConstructor() - static method in class xdoclet.XDocletTagSupport
Provides the current constructor in the XDoclet build, or null if there is no current constructor.
getCurrentField() - method in class xdoclet.DocletSupport
Returns current field.
getCurrentField() - static method in class xdoclet.XDocletTagSupport
Provides the current field in the XDoclet build, or null if there is no current field.
getCurrentFieldTag() - static method in class xdoclet.DocletSupport
Gets the CurrentFieldTag attribute of the DocletSupport field
getCurrentFieldTag() - static method in class xdoclet.XDocletTagSupport
getCurrentLineNum() - method in class xdoclet.template.TemplateEngine
Gets the CurrentLineNum attribute of the TemplateEngine object
getCurrentMethod() - method in class xdoclet.DocletSupport
Returns current method.
getCurrentMethod() - static method in class xdoclet.XDocletTagSupport
Provides the current method in the XDoclet build, or null if there is no current method.
getCurrentMethodTag() - static method in class xdoclet.DocletSupport
Gets the CurrentMethodTag attribute of the DocletSupport class
getCurrentMethodTag() - static method in class xdoclet.XDocletTagSupport
getCurrentPackage() - method in class xdoclet.DocletSupport
Returns current package.
getCurrentPackage() - static method in class xdoclet.XDocletTagSupport
Provides the current package in the XDoclet build, or null if there is no current package.
getCurrentTag() - static method in class xdoclet.DocletSupport
This method is for backward compatiblity only.
getDestDir() - method in class xdoclet.DocletContext
Gets the DestDir attribute of the DocletContext object
getDestDir() - method in class xdoclet.DocletTask
Gets the DestDir attribute of the DocletTask object
getDestDir() - method in class xdoclet.SubTask
Gets the DestDir attribute of the SubTask object
getDestinationFile() - method in class xdoclet.TemplateSubTask
Gets the DestinationFile attribute of the TemplateSubTask object
getDocletContext() - static method in class xdoclet.XDocletTagSupport
getDtdURL() - method in class xdoclet.XmlSubTask
Gets the DtdURL attribute of the XmlSubTask object.
getEngine() - method in class xdoclet.TemplateSubTask
Gets the Engine attribute of the TemplateSubTask object
getEngine() - method in class xdoclet.XDocletTagSupport
Gets the Engine attribute of the TemplateTagHandler object.
getEngineInstance() - static method in class xdoclet.template.TemplateEngine
Gets the EngineInstance attribute of the TemplateEngine class
getExcludedTags() - method in class xdoclet.DocletContext
Gets the ExcludedTags attribute of the DocletContext object
getExcludedTags() - method in class xdoclet.DocletTask
Gets the ExcludedTags attribute of the DocletTask object
The getExpandedDelimitedTagValue method returns a delimited version with class names expanded if requested of the tag value.
getExtent() - method in class xdoclet.TemplateSubTask
Gets the Extent attribute of the TemplateSubTask object
getFieldTypeFor(XField) - static method in class xdoclet.tagshandler.FieldTagsHandler
Gets the FieldTypeFor attribute of the FieldTagsHandler class
getFullClassNameFor(XClass) - static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Returns the full-qualified name of the current class with the package name.
getFullClassNameFor(XClass) - static method in class xdoclet.tagshandler.ClassTagsHandler
Returns the full-qualified name of the specified class with the package name.
getFullSuperclassNameFor(XClass) - static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Returns the full-qualified name of the superclass of the specified class.
Returns class name for the generated file.
getGenerationManager() - method in class xdoclet.TemplateSubTask
getHavingClassTag() - method in class xdoclet.TemplateSubTask
Gets the HavingClassTag attribute of the TemplateSubTask object
A utility method to get the blank space characters used for indenting comments.
getInstance() - static method in class xdoclet.DocletContext
Gets the Instance attribute of the DocletContext class
getInstance() - static method in class xdoclet.util.XmlValidator
Gets the Instance attribute of the XmlValidator class
getLineNumber(String,int) - static method in class xdoclet.template.TemplateEngine
Loops over the template content till reaching tillIndex index and returns the number of lines it has encountered.
getLog(Class,String) - static method in class xdoclet.util.LogUtil
Returns an instance of Jakarta Commons Log object.
getMergeDir() - method in class xdoclet.DocletContext
Gets the MergeDir attribute of the DocletContext object
getMergeDir() - method in class xdoclet.DocletTask
Gets the MergeDir attribute of the DocletTask object
getMergeDir() - method in class xdoclet.SubTask
Gets the MergeDir attribute of the SubTask object
getMergeFileContents(String) - method in class xdoclet.tagshandler.MergeTagsHandler
A utility method used for merging a file used by tag.
getMergeFiles() - method in class xdoclet.template.TemplateParser
Return the list of merge files involved in the generation.
getMethodNameWithoutPrefixFor(XMethod) - static method in class xdoclet.tagshandler.MethodTagsHandler
Merge with modified SubTask.methodNameWithoutPrefix
getMethodParamTypeFor(XParameter) - static method in class xdoclet.tagshandler.ParameterTagsHandler
getMethodTypeFor(XMethod) - static method in class xdoclet.tagshandler.MethodTagsHandler
getName() - method in class xdoclet.ConfigParameter
Gets the Name attribute of the ConfigParameter object
getNamespaces() - method in class xdoclet.template.TemplateEngine
Returns a Set of Strings that represent the registered namespaces
getNestedException() - method in class xdoclet.template.TemplateException
Gets the NestedException attribute of the TemplateException object
getNewestFileOnClassPath() - static method in class xdoclet.loader.ModuleFinder
Get the newest Jar file on the classpath.
getOfType() - method in class xdoclet.TemplateSubTask
Gets the OfType attribute of the TemplateSubTask object
getOutput() - method in class xdoclet.template.TemplateEngine
Gets the Output attribute of the TemplateEngine object
getPackageNameFor(String) - static method in class xdoclet.tagshandler.PackageTagsHandler
Gets a package name with any subsitutions applied.
getPackageNameFor(String,boolean) - static method in class xdoclet.tagshandler.PackageTagsHandler
Apply package substitutions.
getPackageNameFor(XPackage,boolean) - static method in class xdoclet.tagshandler.PackageTagsHandler
Gets the name of a package, optionally applying any substitutions.
getPackages() - method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution
Gets the Packages attribute of the PackageSubstitution object
getPackageSubstitutions() - method in class xdoclet.DocletTask
Gets the PackageSubstitutions attribute of the EjbDocletTask object
getPackageSubstitutions() - method in class xdoclet.TemplateSubTask
Gets the PackageSubstitutions attribute of the TemplateSubTask object
getPackageSubstitutions(String) - static method in class xdoclet.tagshandler.PackageTagsHandler
Gets any PackageSubstitutions defined for a specified subtask.
getParserInstance() - static method in class xdoclet.template.TemplateParser
Gets the ParserInstance attribute of the TemplateParser class
getPrintStackTrace() - method in class xdoclet.XDocletException
Gets the PrintStackTrace attribute of the XDocletException object
getProperties() - method in class xdoclet.DocletContext
Gets the Properties attribute of the DocletContext object
getProperty(String) - method in class xdoclet.DocletContext
Gets the Property attribute of the DocletContext object
getPropertyNameFor(XMethod) - static method in class xdoclet.tagshandler.MethodTagsHandler
Gets the PropertyNameFor attribute of the MethodTagsHandler class
getPublicId() - method in class xdoclet.XmlSubTask
Gets the PublicId attribute of the XmlSubTask object.
getSchema() - method in class xdoclet.XmlSubTask
Gets the Schema attribute of the XmlSubTask object.
getString(Class,String) - static method in class xdoclet.util.Translator
Gets the String attribute of the Translator class.
getString(Class,String,String[]) - static method in class xdoclet.util.Translator
Gets the String attribute of the Translator class.
getString(Properties) - method in class xdoclet.tagshandler.TranslatorTagsHandler
Returns a localized text string.
getString(String,String) - static method in class xdoclet.util.Translator
Gets the String attribute of the Translator class.
getString(String,String,String[]) - static method in class xdoclet.util.Translator
Gets the String attribute of the Translator class.
getSubstituteWith() - method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution
Gets the SubstituteWith attribute of the PackageSubstitution object
getSubTaskBy(String) - method in class xdoclet.DocletContext
Gets the SubTaskBy attribute of the DocletContext object
getSubTaskClassName() - method in class xdoclet.TemplateSubTask
Gets the SubTaskClassName attribute of the TemplateSubTask object
getSubTaskDefinitions() - method in class xdoclet.loader.XDocletModule
getSubTaskName() - method in class xdoclet.SubTask
Gets the SubTaskName attribute of the SubTask object
getSubTaskName(Class) - static method in class xdoclet.DocletTask
getSubTasks() - method in class xdoclet.DocletContext
Gets the SubTasks attribute of the DocletContext object
getSubTasks() - method in class xdoclet.DocletTask
Gets the SubTasks attribute of the DocletTask object
getSystemId() - method in class xdoclet.XmlSubTask
Gets the SystemId attribute of the XmlSubTask object.
getTagHandlerDefinitions() - method in class xdoclet.loader.XDocletModule
getTagHandlerFor(String) - method in class xdoclet.template.TemplateEngine
Get the tag handler for the prefix.
getTagHandlerFor(String) - method in class xdoclet.template.TemplateParser
Gets the TagValue attribute of the XDocletTagSupport class
getTagValue(Properties,int) - static method in class xdoclet.XDocletTagSupport
Return the Value of a tag specified in a Properties object.
getTemplateURL() - method in class xdoclet.template.TemplateEngine
Returns current template URL.
getTemplateURL() - method in class xdoclet.TemplateSubTask
Gets the TemplateURL attribute of the TemplateSubTask object
getterMethod() - method in class xdoclet.tagshandler.MethodTagsHandler
Returns the getter method name for the current method by prefixing the method name with the proper getter prefix.
getterPrefix() - method in class xdoclet.tagshandler.MethodTagsHandler
Returns 'get' or 'is' getter prefix part of the current method.
getTransformedMethodTypeFor(XMethod) - static method in class xdoclet.tagshandler.MethodTagsHandler
getType() - method in class xdoclet.TemplateSubTask.OfType
getURLContent(URL) - static method in class xdoclet.util.FileManager
Gets the URLContent attribute of the FileManager class
getUseFirst() - method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution
return the useAny attribute.
getUseIds() - method in class xdoclet.XmlSubTask
Gets the UseIds attribute of the XmlSubTask object.
getValue() - method in class xdoclet.ConfigParameter
Gets the Value attribute of the ConfigParameter object
getValues() - method in class xdoclet.TemplateSubTask.ExtentTypes
Searches for the XExecutableMember of the member with name methodName and returns it.
Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object
getXJavaDoc() - method in class xdoclet.SubTask
getXJavaDoc() - static method in class xdoclet.template.TemplateTagHandler
getXMethodForMethodName(String) - static method in class xdoclet.tagshandler.PropertyTagsHandler
Searches for the XMethod of the method with name methodName and returns it.
getXMethodForMethodName(String,boolean) - static method in class xdoclet.tagshandler.PropertyTagsHandler
getXmlencoding() - method in class xdoclet.XmlSubTask
Gets the Xmlencoding attribute of the XmlSubTask object.
getXTagsDefinitionURL() - method in class xdoclet.loader.XDocletModule

H

handleTag(int,String) - method in class xdoclet.template.TemplateEngine
Handle the tag that starts at index in the template provided.
hasMergeFile(String) - method in class xdoclet.template.TemplateParser
Callback by the MergeTagsHandler to know if a merge file has already been taken into account.
hasMethod(XClass,String,String[],boolean) - static method in class xdoclet.tagshandler.MethodTagsHandler
Returns true if a method with the specified methodName+parameters is found in the class clazz.
hasTag(Properties,int) - static method in class xdoclet.XDocletTagSupport
A utility method used by ifHasClassTag/ifDoesntHaveClassTag and ifHasMethodTag/ifDoesntHaveMethodTag, return true if at least one tag exists with the specified name.

I

id(Properties) - method in class xdoclet.tagshandler.IdTagsHandler
Generates an id attribute based on the given tag values.
ID_PARAM_MISSING - static field in class xdoclet.tagshandler.XDocletTagshandlerMessages
IdTagsHandler - class xdoclet.tagshandler.IdTagsHandler
ifClassTagValueEquals(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Evaluates the body if value for the class tag equals the specified value.
ifClassTagValueMatches(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Evaluate the body if the match variable equals with the value of the specified tag/parameter.
Evaluates the body if value for the class tag not equals the specified value.
ifConfigParamEquals(String,Properties) - method in class xdoclet.tagshandler.ConfigTagsHandler
Evaluate the body if the value of the configuration parameter equals value.
ifConfigParamEquals_Impl(Properties) - method in class xdoclet.tagshandler.ConfigTagsHandler
The implementation of ifConfigParamEquals and ifConfigParamEquals tags.
Evaluate the body if the value of the configuration parameter is greater or equal to value.
The implementation of ifConfigParamGreaterOrEquals and ifConfigParamNotGreaterOrEquals tags.
ifConfigParamNotEquals(String,Properties) - method in class xdoclet.tagshandler.ConfigTagsHandler
Evaluate the body if the value of the configuration parameter doesn't equal value.
Evaluate the body if the value of the configuration parameter is not greater or equal to value.
Evaluates the body if value for the constructor tag equals the specified value.
Evaluates the body if value for the constructor tag not equals the specified value.
ifDoesntHaveClassTag(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Evaluates the body if current class doesn't have at least one tag with the specified name.
Evaluate the body if current class doesn't have a constructor with the specified name+parameters.
Evaluates the body if current constructor doesn't have at least one tag with the specified name.
ifDoesntHaveFieldTag(String,Properties) - method in class xdoclet.tagshandler.FieldTagsHandler
Evaluates the body if current field doesnt have any tags with the specified name.
ifDoesntHaveMethod(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluate the body if current class doesn't have a method with the specified name+parameters.
ifDoesntHaveMethodTag(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if current method doesn't have at least one tag with the specified name.
ifDoesntReturnVoid(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body block if current method doesn't return void.
ifDoesntThrowException(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluate the body block if current method doesn't throw the exceptions specified in the exceptions attribute.
ifFieldTagValueEquals(String,Properties) - method in class xdoclet.tagshandler.FieldTagsHandler
Evaluates the body if value for the field tag equals the specified value.
ifHasClassTag(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Evaluates the body if current class has at least one tag with the specified name.
ifHasConfigParam(String,Properties) - method in class xdoclet.tagshandler.ConfigTagsHandler
Evaluates the body if config parameter specified is not null.
ifHasConstructor(String,Properties) - method in class xdoclet.tagshandler.ConstructorTagsHandler
Evaluate the body if current class has a constructor with the specified name+parameters.
Evaluates the body if current constructor has at least one tag with the specified name.
ifHasFieldTag(String,Properties) - method in class xdoclet.tagshandler.FieldTagsHandler
Evaluates the body if current field has at least one tag with the specified name.
The block tag ifHasGetMethodWithTag looks for a get method based on the attribute name from the current method, sets the current method to that get method, and applies the template if found.
ifHasMethod(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluate the body if current class has a method with the specified name+parameters.
ifHasMethodComment(String) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body block if current method has a javadoc comment.
ifHasMethodTag(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if current method has at least one tag with the specified name.
ifHasParams(String,Properties) - method in class xdoclet.tagshandler.ParameterTagsHandler
Evaluates the body of the tag if current method/constructor has parameters.
ifHasParamWithTag(String,Properties) - method in class xdoclet.tagshandler.PropertyTagsHandler
Determines if there is a get or set method with the required tag for the current property that also has the requested parameter.
The block tag ifHasSetMethodWithTag looks for a set method based on the attribute name from the current method, sets the current method to that set method, and applies the template if found.
ifIsAbstract(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluate the body block if current method is abstract.
ifIsClassAbstract(String) - method in class xdoclet.tagshandler.ClassTagsHandler
Evaluate the body block if current class is abstract.
ifIsClassNotAbstract(String) - method in class xdoclet.tagshandler.ClassTagsHandler
Evaluate the body block if current class is not abstract.
ifIsGetter(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if the specified method (or current method if none is supplied) is a getter method.
ifIsNotAbstract(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body block if current method is not abstract.
ifIsNotOfType(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if the return type of the current method doesn't equal the specified value.
ifIsNotOfType(String,Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Evaluate the body block if the entity is not of the specified type.
ifIsNotPrimitive(String,Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Evaluate the body block if the value is not of a primitive type.
ifIsNotPrimitiveArray(String,Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Evaluate the body block if the value is not of a primitive array type.
ifIsNotPrimitiveOrString(String,Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Evaluate the body block if the value is of a primitive type or String.
ifIsOfType(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if the return type of the current method equals the specified value.
ifIsOfType(String,Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Evaluate the body block if the entity is of the specified type.
ifIsOfType_Impl(String,Properties,boolean) - method in class xdoclet.tagshandler.TypeTagsHandler
Implementation of ifIsOfType and ifIsNotOfType tags.
ifIsOfTypeImpl(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
ifIsPrimitive(String,Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Evaluate the body block if the value is of a primitive type.
ifIsPrimitiveArray(String,Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Evaluate the body block if the value is of a primitive array type.
ifIsPrimitiveOrString(String,Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Evaluate the body block if the value is of a primitive type or String.
ifIsPublic(String) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if the current method has public visibility.
ifIsSetter(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if the specified method (or current method if none is supplied) is a setter method.
ifMergeFileExists(String,Properties) - method in class xdoclet.tagshandler.MergeTagsHandler
Evaluates the body if the file exists specified by the "file" attribute.
ifMethodNameEquals(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if method name equals to the specified value.
ifMethodNameNotEquals(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if method name equals to the specified value.
ifMethodTagValueEquals(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluates the body if value for the method tag equals the specified value.
Evaluates the body if value for the method tag not equals the specified value.
ifReturnsVoid(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluate the body block if current method returns void.
ifThrowsException(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluate the body block if current method throws the exceptions specified in the exceptions attribute.
ILLEGAL_ACCESS_EXCEPTION - static field in class xdoclet.XDocletMessages
implementationClass - field in class xdoclet.loader.SubTaskDefinition
importedList(Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Iterates over all imported classes and packages imported in the current class and returns the list.
INCORRECT_CLASSPATH - static field in class xdoclet.XDocletMessages
init() - method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
Initialize internal instance of XMLCatalog
init(XJavaDoc) - method in class xdoclet.SubTask
Initializes SubTask.
init(XJavaDoc) - method in class xdoclet.TemplateSubTask
Describe what the method does
INIT_CLASSPATH_NOT_CALLED - static field in class xdoclet.loader.LoaderMessages
INIT_FAILED - static field in class xdoclet.util.XDocletUtilMessages
INIT_TEMPLATE_ENGINE_FAILED - static field in class xdoclet.XDocletMessages
initClasspath(Class) - static method in class xdoclet.loader.ModuleFinder
Initialises the classpath.
INSTANTIATION_EXCEPTION - static field in class xdoclet.XDocletMessages
INVALID_TAG_PARAM_VALUE_CLASS - static field in class xdoclet.XDocletMessages
INVALID_TAG_PARAM_VALUE_FIELD - static field in class xdoclet.XDocletMessages
INVALID_TAG_PARAM_VALUE_METHOD - static field in class xdoclet.XDocletMessages
INVALID_ZIP_FILE - static field in class xdoclet.loader.LoaderMessages
invoke(Method,Object,Object[]) - method in class xdoclet.template.TemplateEngine
Describe what the method does
invoke(Method,Object,Object[]) - method in class xdoclet.template.TemplateParser
Describe what the method does
Invokes content tag implementation method named cmd with the specified set of attributes.
Describe what the method does
Invokes content tag implementation method named cmd.
isDocletGenerated(XClass) - static method in class xdoclet.DocletSupport
Returns true if the clazz generated by xdoclet.
isForce() - method in class xdoclet.DocletContext
Gets the Force attribute of the DocletContext object.
isForce() - method in class xdoclet.DocletTask
Gets the Force attribute of the DocletTask object.
Verify if the generation of a file to generate is needed because either the Template used to generate the file have a later timestamp, or because ALL the Java sources imported in this task have a sooner timestamp.
Test if a Java source mmust be generated or not depending of timestamp of elements involved.
isGetter(String) - static method in class xdoclet.tagshandler.MethodTagsHandler
Returns true if the str string starts with a getter prefix ("get" or "is").
isGetterMethod(XMethod) - static method in class xdoclet.tagshandler.MethodTagsHandler
Gets the GuessGenerationNeeded attribute of the GenerationManager object
isOfType(XClass,String,int) - static method in class xdoclet.tagshandler.TypeTagsHandler
Returns true if cur_class is of type type.
By default supports, but some subtasks may not support because global packageSubstitution is for public interfaces/classes, not good for impl classes.
Gets the PrefixWithPackageStructure attribute of the TemplateSubTask object
isPrimitiveArray(String) - static method in class xdoclet.tagshandler.TypeTagsHandler
Returns true if name is a primitive type and is an array (ends with [])
isPrimitiveType(String) - static method in class xdoclet.tagshandler.TypeTagsHandler
Returns true if name is a primitive type, in that case name contains the string "int"/"float"/etc.
isSetter(String) - static method in class xdoclet.tagshandler.MethodTagsHandler
Returns true if the str string starts with "set" prefix.
isSetterMethod(XMethod) - static method in class xdoclet.tagshandler.MethodTagsHandler
isSubTaskDefined(String) - method in class xdoclet.DocletContext
Gets the SubTaskDefined attribute of the DocletContext object
isTagValueEqual(Properties,int) - static method in class xdoclet.XDocletTagSupport
A utility method used by ifMethodTagValueEquals/ifMethodTagValueNotEquals and ifClassTagValueEquals/ifClassTagValueNotEquals, return true if the value of the tag/XParameter equals with value.
isValidateXML() - method in class xdoclet.XmlSubTask
Gets the ValidateXML attribute of the XmlSubTask object.
isVerbose() - method in class xdoclet.DocletContext
Gets the Verbose attribute of the DocletContext object.
isVerbose() - method in class xdoclet.DocletTask
Gets the Verbose attribute of the DocletTask object.

J

JAVADOC_COULDNT_LOAD_CLASS - static field in class xdoclet.XDocletMessages
javaFile(String) - static method in class xdoclet.TemplateSubTask
Converts the full qualified class name to a valid path with File.separator characters instead of .

L

LINE_SEPARATOR - static field in class xdoclet.template.PrettyPrintWriter
Convenience variable for printing and matching line separators in a system portable manner.
LINE_SEPARATOR_LEN - static field in class xdoclet.template.PrettyPrintWriter
LOAD_MODULE_ERROR - static field in class xdoclet.loader.LoaderMessages
LoaderMessages - class xdoclet.loader.LoaderMessages
LogUtil - class xdoclet.util.LogUtil

M

makeCopyOfArray(Object[]) - static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Used to protect returned arrays from being modified (sorted, reordered for example).
MANDATORY_TAG_PARAM_MISSING_CLASS - static field in class xdoclet.XDocletMessages
MANDATORY_TAG_PARAM_MISSING_FIELD - static field in class xdoclet.XDocletMessages
MANDATORY_TAG_PARAM_MISSING_METHOD - static field in class xdoclet.XDocletMessages
Throws an XDocletException exception to stop the build process.
Throws an XDocletException exception to stop the build process.
Returns true if output not already generated for clazz, and is of the specified type and has the specified class tag; false otherwise.
matchPattern - static field in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Template can use matchPattern as a place where they can put volatile variable.
matchValue() - method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Returns the value of match variable.
merge(String,Properties) - method in class xdoclet.tagshandler.MergeTagsHandler
Merge contents of the file designated by the file parameter and evaluates the body if the file is not found.
MergeTagsHandler - class xdoclet.tagshandler.MergeTagsHandler
METHOD_FAILED - static field in class xdoclet.XDocletMessages
METHOD_NOT_FOUND - static field in class xdoclet.XDocletMessages
methodComment(Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
The comment for the current method.
methodName(Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Returns the name of the current method.
methodNameWithoutPrefix() - method in class xdoclet.tagshandler.MethodTagsHandler
Returns the name of the current method without the first three characters.
methodParamDescription() - method in class xdoclet.tagshandler.ParameterTagsHandler
The methodParamDescription method returns the comment text associated with the ParamTag for the current Parameter
methodParamName() - method in class xdoclet.tagshandler.ParameterTagsHandler
Returns the name of the current method parameter, current method parameter is set inside a forAllMethodParams tag in each iteration.
methodParamType(Properties) - method in class xdoclet.tagshandler.ParameterTagsHandler
Returns the type of the current method parameter, current method parameter is set inside a forAllMethodParams tag in each iteration.
MethodTagsHandler - class xdoclet.tagshandler.MethodTagsHandler
methodTagValue(Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Iterates over all method tags with the specified tagName for the current method probably inside of a forAllMethodTags body.
methodType(Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Returns the return type of the current method.
modifiers() - method in class xdoclet.tagshandler.ClassTagsHandler
The current class' modifiers.
modifiers() - method in class xdoclet.tagshandler.ConstructorTagsHandler
Describe what the method does
modifiers() - method in class xdoclet.tagshandler.FieldTagsHandler
Describe what the method does
modifiers() - method in class xdoclet.tagshandler.MethodTagsHandler
Any modifiers (static, volatile, etc.) for the current method.
modifiers(int) - method in class xdoclet.XDocletTagSupport
Return the modifiers (static, private, etc.) for the current program element of the specified type.
ModuleFinder - class xdoclet.loader.ModuleFinder
Finds xdoclet modules.
ModulesGrandBuilderTask - class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
Loops over all modules and builds each one.

N

name - field in class xdoclet.loader.SubTaskDefinition
namespace - field in class xdoclet.loader.TagHandlerDefinition
NO_DESCRIPTION - static field in class xdoclet.XDocletMessages
NO_FILESETS - static field in class xdoclet.XDocletMessages
NO_XML_TAGS_ALLOWED - static field in class xdoclet.XDocletMessages
NONEXISTANT_CLASSPATH_ENTRY - static field in class xdoclet.loader.LoaderMessages
now - static field in class xdoclet.tagshandler.ClassTagsHandler
NULL - static field in class xdoclet.ConfigParamIntrospector

O

OBSOLETE_TASK_ATTRIBUTE - static field in class xdoclet.XDocletMessages
Applicable only to per class output generation.
ONLY_CALL_CONSTRUCTOR_NOT_NULL - static field in class xdoclet.tagshandler.XDocletTagshandlerMessages
ONLY_CALL_FIELD_NOT_NULL - static field in class xdoclet.tagshandler.XDocletTagshandlerMessages
ONLY_CALL_METHOD_NOT_NULL - static field in class xdoclet.tagshandler.XDocletTagshandlerMessages
out - field in class xdoclet.template.TemplateEngine
The PrintWriter used for outputing the generated stuff.
output - field in class xdoclet.template.TemplateEngine
outputOf(String) - method in class xdoclet.template.TemplateEngine
Calls generate() of the specified template content but instead of outputing it to the generated file, it returns the generated content.

P

packageName() - method in class xdoclet.tagshandler.PackageTagsHandler
Returns the current package name.
packageNameAsPath() - method in class xdoclet.tagshandler.PackageTagsHandler
Returns the current package name as a path.
packageNameAsPathFor(String) - static method in class xdoclet.tagshandler.PackageTagsHandler
Returns a package name as a path, after applying any substitutions.
packageNameAsPathFor(XPackage) - static method in class xdoclet.tagshandler.PackageTagsHandler
Returns a package name as a path, after applying any substitutions.
packageNameAsPathWithoutSubstitutionFor(XPackage) - static method in class xdoclet.tagshandler.PackageTagsHandler
Returns a package name as a path, without applying any substitutions.
packageOf(String) - method in class xdoclet.tagshandler.PackageTagsHandler
Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag.
It's good practice to put interfaces (such as remote/local interfaces, data objects and home interfaces) in a separate "interfaces" package rather than in the EJB bean implementation package.
PackageTagsHandler - class xdoclet.tagshandler.PackageTagsHandler
Tags which manipulate package names and packages, including substitutions.
PARAMETER_DELIMITER - static field in class xdoclet.XDocletTagSupport
Default delimiter used inside a xdoclet tag attribute.
PARAMETER_MISSING_OR_EMPTY - static field in class xdoclet.XDocletMessages
parameterList(Properties) - method in class xdoclet.tagshandler.ParameterTagsHandler
Iterates over all parameters in current method and returns a string containing definition of all those parameters.
ParameterTagsHandler - class xdoclet.tagshandler.ParameterTagsHandler
paramValueWithTag(Properties) - method in class xdoclet.tagshandler.PropertyTagsHandler
Looks for a get or set method with the required tag for the current property that also has the requested parameter, and returns the value of the requested parameter if present.
parentTaskClass - field in class xdoclet.loader.SubTaskDefinition
PARSING_XDOCLET_XML - static field in class xdoclet.loader.LoaderMessages
popCurrentClass() - method in class xdoclet.DocletSupport
Popes current class from top currentClassStack stack.
popCurrentClass() - static method in class xdoclet.XDocletTagSupport
Pop the current class off the top of the class stack.
prefixedId(Properties) - method in class xdoclet.tagshandler.IdTagsHandler
Generates an id attribute based on the given prefix.
PrettyPrintWriter - class xdoclet.template.PrettyPrintWriter
Extends the PrintWriter class by adding the possibility of emiting empty lines.
PrettyPrintWriter(OutputStream) - constructor for class xdoclet.template.PrettyPrintWriter
Describe what the PrettyPrintWriter constructor does
PrettyPrintWriter(Writer) - constructor for class xdoclet.template.PrettyPrintWriter
Describe what the PrettyPrintWriter constructor does
PrettyPrintWriter(Writer,boolean) - constructor for class xdoclet.template.PrettyPrintWriter
Describe what the PrettyPrintWriter constructor does
print(String) - method in class xdoclet.template.TemplateEngine
Describe what the method does
println() - method in class xdoclet.template.PrettyPrintWriter
processInnerClasses() - method in class xdoclet.TemplateSubTask
Subclasses should override this method and return true if they want startProcessPerClass() to process inner classes too.
property(Properties) - method in class xdoclet.ant.AntPropertyTagsHandler
Returns the values of a configuration parameter with the name paramName.
PROPERTY_MISSING - static field in class xdoclet.ant.XDocletAntMessages
propertyName() - method in class xdoclet.tagshandler.MethodTagsHandler
Returns the property name extracted from the current method name.
PropertyTagsHandler - class xdoclet.tagshandler.PropertyTagsHandler
PropertyTagsHandler.java
propertyTypeWithTag(Properties) - method in class xdoclet.tagshandler.PropertyTagsHandler
The propertyTypeWithTag method figures out the type for the current property with tag by looking for a getter, then a setter.
publicId() - method in class xdoclet.tagshandler.XmlTagsHandler
Returns the DTD's public ID for an XML template.
pushClass(String,Properties) - method in class xdoclet.tagshandler.ClassTagsHandler
Pushes the class specified by value parameter to top of stack making it the current class.
pushCurrentClass(XClass) - method in class xdoclet.DocletSupport
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.
pushCurrentClass(XClass) - static method in class xdoclet.XDocletTagSupport
Push the specified class to the top of the current class stack making it effectively the current class.

R

readerClassName - field in class xdoclet.util.XmlValidator
registerDTD(String,URL) - method in class xdoclet.util.XmlValidator
Registers a local DTD document by its public id.
REGISTERING_MODULES - static field in class xdoclet.loader.LoaderMessages
ReplaceCopy - class xdoclet.ant.ReplaceCopy
Extension of Ant's Copy task that uses XDoclet's template engine to copy instead of Ant's plain copy.
ReplaceCopy() - constructor for class xdoclet.ant.ReplaceCopy
replaceInline(String,String,String) - static method in class xdoclet.tagshandler.PackageTagsHandler
Replace the first occurrence of oldOne in original with newOne, or returns the original string if oldOne is not found.
reset() - static method in class xdoclet.tagshandler.IdTagsHandler
Resets the hashtable which backs the prefixId tag.
resetFoundModules() - static method in class xdoclet.loader.ModuleFinder
resolveEntity(String,String) - method in class xdoclet.util.XmlValidator
Called by parser when a DTD declaration is encountered in the parsed XML document
RUNNING_FAILED - static field in class xdoclet.XDocletMessages
RUNNING_TASKNAME - static field in class xdoclet.XDocletMessages

S

schema() - method in class xdoclet.tagshandler.XmlTagsHandler
Returns the schema for an XML template.
Indicates whether or not to generate for abstract classes.
Indicates whether or not to generate for interfaces.
Sets the ActiveSubTask attribute of the DocletContext object
setAddedTags(String) - method in class xdoclet.DocletTask
Add some JavaDoc tags (or comments) to the generated classes.
setBaseDir(File) - method in class xdoclet.XDocletFacade
setClasspath(String) - static method in class xdoclet.loader.ModuleFinder
setCurrentClass(XClass) - method in class xdoclet.DocletSupport
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
setCurrentClass(XClass) - static method in class xdoclet.XDocletTagSupport
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
setCurrentClassTag(XTag) - static method in class xdoclet.DocletSupport
Sets the CurrentClassTag attribute of the DocletSupport class
setCurrentClassTag(XTag) - static method in class xdoclet.XDocletTagSupport
Sets the current class tag.
Evaluate the body if current class has a constructor with the specified name+parameters.
Sets the CurrentConstructor attribute of the DocletSupport object
Set the current constructor.
setCurrentField(XField) - method in class xdoclet.DocletSupport
Sets the CurrentField attribute of the DocletSupport object
setCurrentField(XField) - static method in class xdoclet.XDocletTagSupport
Set the current field.
setCurrentFieldTag(XTag) - static method in class xdoclet.DocletSupport
Sets the CurrentFieldTag attribute of the DocletSupport field
setCurrentFieldTag(XTag) - static method in class xdoclet.XDocletTagSupport
Sets the current field tag.
setCurrentLineNum(int) - method in class xdoclet.template.TemplateEngine
Sets the CurrentLineNum attribute of the TemplateEngine object
setCurrentMethod(String,Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Evaluate the body if current class has a method with the specified name+parameters.
setCurrentMethod(XMethod) - method in class xdoclet.DocletSupport
Sets the CurrentMethod attribute of the DocletSupport object
setCurrentMethod(XMethod) - static method in class xdoclet.XDocletTagSupport
Set the current method.
setCurrentMethodTag(XTag) - static method in class xdoclet.DocletSupport
Sets the CurrentMethodTag attribute of the DocletSupport class
setCurrentMethodTag(XTag) - static method in class xdoclet.XDocletTagSupport
Sets the current method tag.
setCurrentPackage(XPackage) - method in class xdoclet.DocletSupport
Returns current package.
setCurrentPackage(XPackage) - static method in class xdoclet.XDocletTagSupport
Set the current package.
setDestDir(File) - method in class xdoclet.DocletTask
Destination directory for output files
setDestDir(File) - method in class xdoclet.SubTask
Sets the directory where the generated file(s) will be written.
The destination file name.
setDocEncoding(String) - method in class xdoclet.template.TemplateEngine
set output charset;
setDtdURL(URL) - method in class xdoclet.XmlSubTask
Sets the DtdURL attribute of the XmlSubTask object.
Sets the Engine attribute of the TemplateSubTask object
setExcludedTags(String) - method in class xdoclet.DocletTask
Specify tags that should not be automatically written to output files.
setExcludePackageNames(String) - method in class xdoclet.DocletTask
Sets the ExcludePackageNames attribute of the DocletTask object
You can control the extent in which the type search occurs.
setExtentValue(String) - method in class xdoclet.TemplateSubTask
Sets the ExtentValue attribute of the TemplateSubTask object
setForce(boolean) - method in class xdoclet.DocletTask
Specify if the generation of files should be forced.
Sets the GenerationManager attribute of the TemplateSubTask object
Sets the GuessGenerationNeeded attribute of the GenerationManager object.
setHavingClassTag(String) - method in class xdoclet.TemplateSubTask
Sets the HavingClassTag attribute of the TemplateSubTask object
setInstance(xdoclet.util.XmlValidator) - static method in class xdoclet.util.XmlValidator
Sets the Instance attribute of the XmlValidator class
Sets the value of match variable.
setMergeDir(File) - method in class xdoclet.DocletTask
Directory where subtasks will look for files to be merged with generated files.
setMergeDir(File) - method in class xdoclet.SubTask
Specifies the location of the merge directory.
setName(String) - method in class xdoclet.ConfigParameter
The name of the parameter.
setOfType(String) - method in class xdoclet.TemplateSubTask
setOutput(File) - method in class xdoclet.template.TemplateEngine
Sets the Output attribute of the TemplateEngine object
setPackageNames(String) - method in class xdoclet.DocletTask
Sets the PackageNames attribute of the DocletTask object
setPackages(String) - method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution
Sets the Packages attribute of the PackageSubstitution object
Indicates whether or not package substitution should be inherited
Sets the PackageSubstitutions attribute of the TemplateSubTask object
setPackageSubstitutions(List) - method in class xdoclet.DocletTask
Sets the PackageSubstitutions attribute of the EjbDocletTask object
Indicates whether or not to prefix with package structure.
setPublicId(String) - method in class xdoclet.XmlSubTask
The PUBLIC ID of the DTD to which the generated document should conform.
setSchema(String) - method in class xdoclet.XmlSubTask
The XML Schema to which the generated document should conform.
Sets the SingleInstance attribute of the DocletContext class
Sets the SubstituteWith attribute of the PackageSubstitution object
Sets the SubTaskClassName attribute of the TemplateSubTask object
setSubTaskName(String) - method in class xdoclet.SubTask
Sets an optional name for the subtask that will be seen in XDoclet's debug messages.
setSystemId(String) - method in class xdoclet.XmlSubTask
The SYSTEM ID of the DTD to which the generated document should conform.
Sets the TagHandlerFor attribute of the TemplateEngine object
setTarget(String) - method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
set the name of the target to be called in each of the modules' build files
setTemplateFile(File) - method in class xdoclet.TemplateSubTask
Sets the name of the template file to use for generation
setTemplateURL(URL) - method in class xdoclet.template.TemplateEngine
A config parameter settable from Ant build file.
setTemplateURL(URL) - method in class xdoclet.TemplateSubTask
This method should be called to set a template file programmatically.
setterMethod() - method in class xdoclet.tagshandler.MethodTagsHandler
Returns the setter method name for the current method by prefixing the method name with a 'set' and removing the getter method's 'get' or 'is' prefixes, if any.
setType(String) - method in class xdoclet.TemplateSubTask.OfType
setUseFirst(boolean) - method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution
Sets the useFirst attribute
setUseIds(boolean) - method in class xdoclet.XmlSubTask
If this attribute is set to true, XDoclet will generate id attributes in the XML document.
setValidateXML(boolean) - method in class xdoclet.XmlSubTask
If this is set to true, the generated XML will be validated against its DTD or XML Schema.
setValue(String) - method in class xdoclet.ConfigParameter
The value of the parameter.
setVerbose(boolean) - method in class xdoclet.DocletTask
Sets the Verbose attribute of the DocletTask object.
Sets the Writer attribute of the TemplateEngine object
setXJavaDoc(XJavaDoc) - method in class xdoclet.template.TemplateEngine
setXJavaDoc(XJavaDoc) - static method in class xdoclet.template.TemplateTagHandler
setXmlencoding(String) - method in class xdoclet.XmlSubTask
The encoding of the produced xml file.
SKIP_NO_XDOCLET_XML - static field in class xdoclet.loader.LoaderMessages
skipToken(Properties) - method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
Skips current token.
skipWhitespace(String,int) - static method in class xdoclet.template.TemplateEngine
Skips whitespaces, starting from index i till the first non-whitespace character or end of template and returns the new index.
start() - method in class xdoclet.DocletTask
start() - method in class xdoclet.template.TemplateEngine
A utility method used for generating the dest_file based on template_file template file.
start() - method in class xdoclet.template.TemplateParser
A utility method used for generating the dest_file based on template_file template file.
start(XJavaDoc) - method in class xdoclet.XDocletMain
Starts XDoclet
startEngine(URL,File) - method in class xdoclet.TemplateSubTask
Describe what the method does
startProcess() - method in class xdoclet.TemplateSubTask
Describe what the method does
startProcess() - method in class xdoclet.XmlSubTask
Describe what the method does
startProcessForAll() - method in class xdoclet.TemplateSubTask
startProcessPerClass() - method in class xdoclet.TemplateSubTask
stringToBoolean(String,boolean) - static method in class xdoclet.util.TypeConversionUtil
A utility method for converting a string to a boolean.
SubTask - class xdoclet.SubTask
An abstract base class for all sub-tasks.
SubTaskDefinition - class xdoclet.loader.SubTaskDefinition
SubTaskDefinition(String,String,String) - constructor for class xdoclet.loader.SubTaskDefinition
symbolicClassName() - method in class xdoclet.tagshandler.ClassTagsHandler
Returns the symbolic name of the current class.
systemId() - method in class xdoclet.tagshandler.XmlTagsHandler
Returns the DTD's system ID for an XML template.

T

TAG_MALFORMED_VALUE - static field in class xdoclet.XDocletMessages
TAG_MAPPINGS_FILE - static field in class xdoclet.template.TemplateEngine
TAG_MISSING_EQUALS - static field in class xdoclet.XDocletMessages
TAG_MUST_ESCAPE_QUOTES - static field in class xdoclet.XDocletMessages
TAG_MUST_INCLUDE_A_PROPERTY - static field in class xdoclet.XDocletMessages
TAG_NO_CLOSING_QUOTE - static field in class xdoclet.XDocletMessages
TAG_QUOTE_EXPECTED - static field in class xdoclet.XDocletMessages
tagDef(Properties) - method in class xdoclet.tagshandler.TagDefTagsHandler
Defines a template tag handler for a template tag to TemplateEngine.
TAGDEF_COULDNT_DEF_HANDLER - static field in class xdoclet.tagshandler.XDocletTagshandlerMessages
TAGDEF_ILLEGALACCESS_EXCEPTION - static field in class xdoclet.tagshandler.XDocletTagshandlerMessages
TAGDEF_INSTANTIATION_EXCEPTION - static field in class xdoclet.tagshandler.XDocletTagshandlerMessages
TagDefTagsHandler - class xdoclet.tagshandler.TagDefTagsHandler
The implementation of TagDef template tag.
TagHandlerDefinition(String,String) - constructor for class xdoclet.loader.TagHandlerDefinition
Describe what the TagHandlerDefinition constructor does
tagTokenizer - static field in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
The StringTokenizer object doing the tokenization.
TAGVALUE_NULL - static field in class xdoclet.XDocletMessages
TEMPLATE_CLASSNOTFOUNDEXCEPTION - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_CLOSE_TAG_MISSING - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_CORRESPONDING_TAG_MISSING - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_COULDNT_LOAD_MAPPINGS - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_EQUALS_EXPECTED - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_ERROR_WRITING_OUTPUT - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_GT_EXPECTED - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_ILLEGALACCESSEXCEPTION - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_INSTANTIATIONEXCEPTION - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_INVOKE_METHOD_FAILED - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_IOEXCEPTION - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_NO_SUCH_METHOD - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_NO_TAGHANDLER - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_NOCLASSDEFFOUNDERROR - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_NOT_FOUND - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_PARAMETER_MISSING - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_QUOTE_EXPECTED - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_SYNTAX_ERROR - static field in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_TAGNAME_IS_NULL - static field in class xdoclet.XDocletMessages
TemplateEngine - class xdoclet.template.TemplateEngine
The default template engine used by derived SubTasks.
TemplateEngine() - constructor for class xdoclet.template.TemplateEngine
TemplateException - class xdoclet.template.TemplateException
TemplateException(Exception,String) - constructor for class xdoclet.template.TemplateException
Describe what the TemplateException constructor does
TemplateException(String) - constructor for class xdoclet.template.TemplateException
Describe what the TemplateException constructor does
TemplateParser - class xdoclet.template.TemplateParser
Subclass of Template Engine that do not generate anything but only parse the document.
TemplateParser() - constructor for class xdoclet.template.TemplateParser
Initialize the Template Engine.
Generic subtask for processing a user-supplied template.
TemplateSubTask() - constructor for class xdoclet.TemplateSubTask
TemplateTagHandler - class xdoclet.template.TemplateTagHandler
testParse() - method in class xdoclet.loader.XDocletXmlParserTest
testProcess() - method in class xdoclet.XDocletFacadeTest
tokenizeDelimitedToArray(String,String) - static method in class xdoclet.util.DocletUtil
Return an array of String from a String containing delimited values.
topoSort(String,Hashtable) - method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
transformedClassName() - method in class xdoclet.tagshandler.ClassTagsHandler
Returns the transformed name of the current class with package name.
transformedMethodType(Properties) - method in class xdoclet.tagshandler.MethodTagsHandler
Returns the transformed return type of the current method.
Translator - class xdoclet.util.Translator
Utility class for doing i18n translations.
TranslatorTagsHandler - class xdoclet.tagshandler.TranslatorTagsHandler
Wrapper around the Translator, allowing text in generated files to be localised using the resource bundles generated by the externalizer subtask.
TYPE_CONCRETE_TYPE - static field in class xdoclet.tagshandler.TypeTagsHandler
Used by isOfType.
TYPE_HIERARCHY - static field in class xdoclet.tagshandler.TypeTagsHandler
Used by isOfType.
TYPE_SUPERCLASS - static field in class xdoclet.tagshandler.TypeTagsHandler
Used by isOfType.
TypeTagsHandler - class xdoclet.tagshandler.TypeTagsHandler
Simple tag support class.
typeWithoutDimensions(Properties) - method in class xdoclet.tagshandler.TypeTagsHandler
Returns the type specified with the type parameter without dimensions.

V

validate(File) - method in class xdoclet.util.XmlValidator
Validates an XML file for conformance to a declared DTD or XMLSchema.
validateOptions() - method in class xdoclet.DocletTask
Called by superclass before start() is called
validateOptions() - method in class xdoclet.SubTask
Called to validate configuration parameters.
validateOptions() - method in class xdoclet.TemplateSubTask
Called to validate configuration parameters.
validateSubTasks() - method in class xdoclet.DocletTask
Describe what the method does

W

warning(SAXParseException) - method in class xdoclet.util.XmlValidator
Called by parser if a warning occurs
write(int) - method in class xdoclet.template.PrettyPrintWriter
write(pBuffer[],int,int) - method in class xdoclet.template.PrettyPrintWriter
Describe what the method does
write(String,int,int) - method in class xdoclet.template.PrettyPrintWriter
Describe what the method does
writeLine() - method in class xdoclet.template.PrettyPrintWriter
writeURLContent(URL,File) - static method in class xdoclet.util.FileManager
Describe what the method does

X

xdoclet - package
xdoclet.ant - package
xdoclet.loader - package
This package implements the functionality required to load drop-in modules dynamically.
xdoclet.util - package
XDOCLET_FAILED - static field in class xdoclet.XDocletMessages
XDOCLET_HEAD - static field in class xdoclet.template.TemplateEngine
XDOCLET_HEAD_LEN - static field in class xdoclet.template.TemplateEngine
XDOCLET_PREFIX - static field in class xdoclet.template.TemplateEngine
XDOCLET_TAIL - static field in class xdoclet.template.TemplateEngine
XDOCLET_TAIL_LEN - static field in class xdoclet.template.TemplateEngine
XDOCLET_VERSION - static field in class xdoclet.DocletTask
Describe what the XDocletException constructor does
XDocletException(String) - constructor for class xdoclet.XDocletException
Describe what the XDocletException constructor does
XDocletFacade() - constructor for class xdoclet.XDocletFacade
XDocletFacadeTest(String) - constructor for class xdoclet.XDocletFacadeTest
XDocletMain - class xdoclet.XDocletMain
This class serves as an entry-point for starting XDoclet.
All messages resource keys should be defined in a Messages class, per package, as constants.
XDocletModule - class xdoclet.loader.XDocletModule
This is an object view of the data in xdoclet.xml
XDocletModule() - constructor for class xdoclet.loader.XDocletModule
Derives from TemplateTagHandler and adds handy support methods for working with Javadoc Doclet classes.
XDocletXmlParserTest(String) - constructor for class xdoclet.loader.XDocletXmlParserTest
xmlReader - field in class xdoclet.util.XmlValidator
XMLReader used for validation
XmlSubTask - class xdoclet.XmlSubTask
Generic subtask for processing a user-supplied template, to generate an XML document.
XmlTagsHandler - class xdoclet.tagshandler.XmlTagsHandler
XML template support tags.
XmlValidator - class xdoclet.util.XmlValidator
This handler implementation is capable of providing dtds from a local storage instead of accessing them over the net.
XmlValidator(ClassLoader) - constructor for class xdoclet.util.XmlValidator
Describe what the XmlValidator constructor does