Index (XDoclet 1.2.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

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

A

AMBIGUOUS_SUBTASK_DEFINITION - Static variable in class xdoclet.XDocletMessages
ATTRIBUTE_NOT_PRESENT_ERROR - Static variable in class xdoclet.XDocletMessages
ATTRIBUTE_NOT_SET_ERROR - Static variable in class xdoclet.tagshandler.XDocletTagshandlerMessages
ATTRIBUTE_NOT_SUPPORTED - Static variable in class xdoclet.XDocletMessages
AbstractProgramElementTagsHandler - class xdoclet.tagshandler.AbstractProgramElementTagsHandler.
AbstractProgramElementTagsHandler() - Constructor for class xdoclet.tagshandler.AbstractProgramElementTagsHandler
AntPropertyTagsHandler - class xdoclet.ant.AntPropertyTagsHandler.: Extracts properties from Ant.
AntPropertyTagsHandler(Hashtable) - Constructor for class xdoclet.ant.AntPropertyTagsHandler: Describe what the AntPropertyTagsHandler constructor does
addConfigParam(ConfigParameter) - Method in class xdoclet.DocletTask: Allows to set configuration parameters that will be included in the element as attribute value pair.
addConfigParam(ConfigParameter) - Method in class xdoclet.SubTask: 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(TemplateSubTask.OfType) - Method in class xdoclet.TemplateSubTask
addOfType(String) - Method in class xdoclet.TemplateSubTask
addPackageSubstitution(PackageTagsHandler.PackageSubstitution) - Method in class xdoclet.DocletTask: Substitutes the package of the generated files.
addPackageSubstitution(PackageTagsHandler.PackageSubstitution) - Method in class xdoclet.TemplateSubTask: Substitutes the package of the generated files.
addSubTask(SubTask) - Method in class xdoclet.DocletTask: Generic subtask.
addSubTask(String, String, String) - Method in class xdoclet.loader.XDocletModule
addTagHandler(String, String) - Method in class xdoclet.loader.XDocletModule
addTemplate(TemplateSubTask) - Method in class xdoclet.DocletTask: Generic subtask for processing a user-supplied template.
addXmlTemplate(XmlSubTask) - Method in class xdoclet.DocletTask: Generic subtask for processing a user-supplied template, to generate an XML document.

B

BAD_GETTEXT_DOC_TYPE - Static variable in class xdoclet.XDocletMessages
BAD_PRGELEMDOC_TYPE - Static variable in class xdoclet.XDocletMessages
BAD_TAGVALUE_TYPE - Static variable in class xdoclet.XDocletMessages
BAD_XDOCLET_XML - Static variable in class xdoclet.loader.LoaderMessages

C

CHECK_CLASS_FAILED - Static variable in class xdoclet.XDocletMessages

CLASS_CAST_EXCEPTION - Static variable in class xdoclet.XDocletMessages

CLASS_NOT_FOUND - Static variable in class xdoclet.XDocletMessages

CLASS_NOT_FOUND_EXCEPTION - Static variable in class xdoclet.XDocletMessages

CLASS_TAG_EXPECTED - Static variable in class xdoclet.XDocletMessages

CLASS_TAG_PARAMETER_EXPECTED - Static variable in class xdoclet.XDocletMessages

CONTEXT_READ_ERROR - Static variable in class xdoclet.XDocletMessages

CONTEXT_WRITE_ERROR - Static variable in class xdoclet.XDocletMessages

COULDNT_CONF_XML_PARSER - Static variable in class xdoclet.XDocletMessages

COULDNT_FIND_BEAN - Static variable in class xdoclet.XDocletMessages

COULDNT_FIND_DTD - Static variable in class xdoclet.XDocletMessages

COULDNT_INIT_XML_PARSER - Static variable in class xdoclet.XDocletMessages

COULDNT_INSTANTIATE_SUBTASK - Static variable in class xdoclet.XDocletMessages

COULDNT_LOAD_DTD - Static variable in class xdoclet.XDocletMessages

COULDNT_LOAD_LOCAL_DTD - Static variable in class xdoclet.XDocletMessages

COULDNT_LOAD_XML_FILE - Static variable in class xdoclet.XDocletMessages

CREATE_TASK_ERROR - Static variable in class xdoclet.XDocletMessages

ClassTagsHandler - class xdoclet.tagshandler.ClassTagsHandler.

Tags relating to classes being processed and class-level attributes.

ClassTagsHandler() - Constructor for class xdoclet.tagshandler.ClassTagsHandler

CommentTagsHandler - class xdoclet.tagshandler.CommentTagsHandler.

CommentTagsHandler() - Constructor for class xdoclet.tagshandler.CommentTagsHandler

ConfigParamIntrospector - class xdoclet.ConfigParamIntrospector.

Used by DocletTask.

ConfigParamIntrospector() - Constructor for class xdoclet.ConfigParamIntrospector

ConfigParameter - class xdoclet.ConfigParameter.

Allows to set configuration parameters that will be included in the element as attribute value pair.
The following input

will give

ConfigParameter() - Constructor for class xdoclet.ConfigParameter

ConfigTagsHandler - class xdoclet.tagshandler.ConfigTagsHandler.

ConfigTagsHandler() - Constructor for class xdoclet.tagshandler.ConfigTagsHandler

ConstructorTagsHandler - class xdoclet.tagshandler.ConstructorTagsHandler.

ConstructorTagsHandler() - Constructor for class xdoclet.tagshandler.ConstructorTagsHandler

capitalize(String) - Static method in class xdoclet.ConfigParamIntrospector

Describe what the method does

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.

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 - Variable in class xdoclet.util.XmlValidator

className - Variable 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.

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.

configParameterValue(Properties) - Method in class xdoclet.tagshandler.ConfigTagsHandler

Returns the values of a configuration parameter with the name paramName.

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.

copyAttributesFrom(TemplateSubTask) - Method in class xdoclet.SubTask

Describe what the method does

copyAttributesFrom(TemplateSubTask) - Method in class xdoclet.TemplateSubTask

Describe what the method does

copyAttributesFrom(TemplateSubTask) - Method in class xdoclet.XmlSubTask

Describe what the method does

createDTD() - Method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask

Create a DTD location record; optional.

createDynamicElement(String) - Method in class xdoclet.DocletTask

currentClassTag - Static variable in class xdoclet.DocletSupport

currentConstructorName() - Method in class xdoclet.tagshandler.ConstructorTagsHandler

Returns the current constructor name.

currentFieldTag - Static variable in class xdoclet.DocletSupport

currentMethodName() - Method in class xdoclet.tagshandler.MethodTagsHandler

Returns the current method name.

currentMethodParamTag - Static variable in class xdoclet.tagshandler.ParameterTagsHandler

The currentMethodParamTag holds the current ParamTag corresponding to the current Parameter.

currentMethodParameter - Static variable in class xdoclet.tagshandler.ParameterTagsHandler

The current method's current parameter.

currentMethodTag - Static variable in class xdoclet.DocletSupport

The current Tag.

currentName - Variable in class xdoclet.tagshandler.ParameterTagsHandler

currentName() - Method in class xdoclet.tagshandler.ParameterTagsHandler

return name of parameter currently being iterated - ugly hack...

currentToken - Static variable in class xdoclet.tagshandler.AbstractProgramElementTagsHandler

The current token.

currentToken(Properties) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler

Returns current token inside forAllClassTagTokens.

D

DEFAULT_XML_READER_CLASSNAME - Static variable in class xdoclet.util.XmlValidator: The crimson implementation is shipped with ant.
DEPENDENT_CLASS_FOR_SUBTASK_NOT_FOUND - Static variable in class xdoclet.XDocletMessages
DONE_REGISTERING_MODULES - Static variable in class xdoclet.loader.LoaderMessages
DO_NOT_EDIT - Static variable in class xdoclet.XDocletMessages
DUPLICATED_TAG - Static variable in class xdoclet.XDocletMessages
DocletContext - class xdoclet.DocletContext.
DocletContext(String, String, String, SubTask[], Hashtable, HashMap, boolean, boolean, String) - Constructor for class xdoclet.DocletContext: Describe what the DocletContext constructor does
DocletSupport - class xdoclet.DocletSupport.
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.
DocletUtil() - Constructor for class xdoclet.util.DocletUtil
dateFormatter - Static variable in class xdoclet.tagshandler.ClassTagsHandler: Used for setting the timestamp for xdoclet-generated marker in generated files.
delimit(String, Properties) - Static method in class xdoclet.XDocletTagSupport
doFileOperations() - Method in class xdoclet.ant.ReplaceCopy: Overridden doFileOperations() as Ant suggests.
docEncoding - Variable in class xdoclet.template.TemplateEngine

E

ERROR_CREATING_TEMPLATEENGINE - Static variable in class xdoclet.ant.XDocletAntMessages
EXCEPTION_READING_MERGE_FILE - Static variable in class xdoclet.util.XDocletUtilMessages
EXTENT_TYPE_CONCRETE_TYPE - Static variable in class xdoclet.TemplateSubTask.ExtentTypes
EXTENT_TYPE_HIERARCHY - Static variable in class xdoclet.TemplateSubTask.ExtentTypes
EXTENT_TYPE_SUPERCLASS - Static variable in class xdoclet.TemplateSubTask.ExtentTypes
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
exceptionList(Properties, int) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: Describe what the method does
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.
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
execute() - Method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
executeAndRestoreConstructor(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Evaluate the current block, and then restore the current constructor before continuing.
executeAndRestoreMethod(String, Properties) - Method in class xdoclet.tagshandler.MethodTagsHandler: Evaluate the current block, and then restore the current method before continuing.
expandClassName(String, Properties) - Static method in class xdoclet.XDocletTagSupport
extractExtentType(String) - Static method in class xdoclet.tagshandler.TypeTagsHandler: Return the integer constant based on the extent_str.

F

FAILED_TO_COPY - Static variable in class xdoclet.ant.XDocletAntMessages
FOR_CLASS - Static variable in class xdoclet.XDocletTagSupport
FOR_CONSTRUCTOR - Static variable in class xdoclet.XDocletTagSupport
FOR_FIELD - Static variable in class xdoclet.XDocletTagSupport
FOR_METHOD - Static variable in class xdoclet.XDocletTagSupport
FieldTagsHandler - class xdoclet.tagshandler.FieldTagsHandler.
FieldTagsHandler() - Constructor for class xdoclet.tagshandler.FieldTagsHandler
FileManager - class xdoclet.util.FileManager.: A utility class for handling common filing operations.
FileManager() - Constructor for class xdoclet.util.FileManager
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.
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.
findGetterMethod(Object, String) - Static method in class xdoclet.ConfigParamIntrospector: 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.
firstSentenceDescriptionOfCurrentConstructor() - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Return standard javadoc of current constructor.
firstSentenceDescriptionOfCurrentField() - Method in class xdoclet.tagshandler.FieldTagsHandler: Return standard javadoc of current field.
firstSentenceDescriptionOfCurrentMember(XMember) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: Describe what the method does
firstSentenceDescriptionOfCurrentMethod() - Method in class xdoclet.tagshandler.MethodTagsHandler: Return standard javadoc of current method.
forAllClassConstructors(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Loops through all constructors for all classes after first sorting all the constructors.
forAllClassMethods(String, Properties) - Method in class xdoclet.tagshandler.MethodTagsHandler: Loops through all methods for all classes after first sorting all the methods.
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.
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.
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.
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.
forAllConstructorTagTokens(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Iterates over all tokens in current constructor tag with the name tagName and evaluates the body for every token.
forAllConstructorTags(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Iterates over all tags of current constructor and evaluates the body of the tag for each constructor.
forAllConstructors(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Iterates over all constructors of current class and evaluates the body of the tag for each constructor.
forAllDistinctClassTags(TemplateEngine, String, String, String) - Static method in class xdoclet.tagshandler.ClassTagsHandler: Iterates over all tags named according to tagName in a non-duplicated manner.
forAllDistinctClassTags(String, Properties) - Method in class xdoclet.tagshandler.ClassTagsHandler: Iterates over all tags named according to tagName in a non-duplicated manner.
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.
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.
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.
forAllMemberTagTokens(String, Properties, int) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: Describe what the method does
forAllMemberTags(String, Properties, int, String, String[]) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: Describe what the method does
forAllMembers(String, Properties, int) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
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.
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.
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.
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.
forAllPackages(String, Properties) - Method in class xdoclet.tagshandler.PackageTagsHandler: Iterates over all packages loaded by XJavadoc.
forAllParameterTypes(String, Properties) - Method in class xdoclet.tagshandler.ParameterTagsHandler: 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.
forAllPropertiesWithTag(String, Properties) - Method in class xdoclet.tagshandler.PropertyTagsHandler: 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

GENERATED_BY_XDOCLET - Static variable in class xdoclet.XDocletMessages
GENERATED_XML_INVALID - Static variable in class xdoclet.util.XDocletUtilMessages
GENERATING_SOMETHING - Static variable in class xdoclet.XDocletMessages
GENERATING_TEMPLATE_OUTPUT_PER_CLASS - Static variable in class xdoclet.XDocletMessages
GENERATING_TEMPLATE_OUTPUT_SINGLE_FILE - Static variable in class xdoclet.XDocletMessages
GenerationManager - class xdoclet.GenerationManager.: Verify if the generation is needed for Java files and Xml files based templates.
GenerationManager(XJavaDoc, TemplateSubTask) - Constructor for class xdoclet.GenerationManager: Describe what the GenerationManager constructor does
generate(String) - Method in class xdoclet.XDocletTagSupport
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.
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.
getAcceptAbstractClasses() - Method in class xdoclet.TemplateSubTask
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: Deprecated. use XClass.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(List) - 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
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
getExpandedDelimitedTagValue(Properties, int) - Static method in class xdoclet.XDocletTagSupport: 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: Deprecated. use XClass.qualifiedName()
getFullSuperclassNameFor(XClass) - Static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: Returns the full-qualified name of the superclass of the specified class.
getGeneratedFileName(XClass) - Method in class xdoclet.TemplateSubTask: 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
getIndentChars(Properties) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: 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(XPackage, boolean) - Static method in class xdoclet.tagshandler.PackageTagsHandler: Gets the name of a package, optionally applying any substitutions.
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.
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.
getPackages() - Method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution: Gets the Packages attribute of the PackageSubstitution object
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(Properties) - Method in class xdoclet.tagshandler.TranslatorTagsHandler: Returns a localized text string.
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(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.
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(Class) - Static method in class xdoclet.DocletTask
getSubTaskName() - Method in class xdoclet.SubTask: Gets the SubTaskName attribute of the SubTask object
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
getSubstituteWith() - Method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution: Gets the SubstituteWith attribute of the PackageSubstitution 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
getTagValue(Properties, int) - Static method in class xdoclet.XDocletTagSupport: Return the Value of a tag specified in a Properties object.
getTagValue(int, String, String, String, String, boolean, boolean) - Static method in class xdoclet.XDocletTagSupport: Gets the TagValue attribute of the XDocletTagSupport class
getTagValue(int, XDoc, String, String, String, String, boolean, boolean) - Static method in class xdoclet.XDocletTagSupport
getTemplateURL() - Method in class xdoclet.TemplateSubTask: Gets the TemplateURL attribute of the TemplateSubTask object
getTemplateURL() - Method in class xdoclet.template.TemplateEngine: Returns current template URL.
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
getXExecutableMemberForMemberName(String, int) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object
getXExecutableMemberForMemberName(String, boolean, int) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: Searches for the XExecutableMember of the member with name methodName and returns it.
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
getXTagsDefinitionURL() - Method in class xdoclet.loader.XDocletModule
getXmlencoding() - Method in class xdoclet.XmlSubTask: Gets the Xmlencoding attribute of the XmlSubTask 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.

H

handleTag(int, String) - Method in class xdoclet.template.TemplateEngine: Handle the tag that starts at index in the template provided.
hasExecutableMember(XClass, String, String[], boolean, int) - Static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
hasExecutableMember_OLD(XClass, String, String[], boolean, int) - Static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
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_PARAM_MISSING - Static variable in class xdoclet.tagshandler.XDocletTagshandlerMessages
ILLEGAL_ACCESS_EXCEPTION - Static variable in class xdoclet.XDocletMessages
INCORRECT_CLASSPATH - Static variable in class xdoclet.XDocletMessages
INIT_CLASSPATH_NOT_CALLED - Static variable in class xdoclet.loader.LoaderMessages
INIT_FAILED - Static variable in class xdoclet.util.XDocletUtilMessages
INIT_TEMPLATE_ENGINE_FAILED - Static variable in class xdoclet.XDocletMessages
INSTANTIATION_EXCEPTION - Static variable in class xdoclet.XDocletMessages
INVALID_TAG_PARAM_VALUE_CLASS - Static variable in class xdoclet.XDocletMessages
INVALID_TAG_PARAM_VALUE_CONSTRUCTOR - Static variable in class xdoclet.XDocletMessages
INVALID_TAG_PARAM_VALUE_FIELD - Static variable in class xdoclet.XDocletMessages
INVALID_TAG_PARAM_VALUE_METHOD - Static variable in class xdoclet.XDocletMessages
INVALID_ZIP_FILE - Static variable in class xdoclet.loader.LoaderMessages
IdTagsHandler - class xdoclet.tagshandler.IdTagsHandler.
IdTagsHandler() - Constructor for class xdoclet.tagshandler.IdTagsHandler
id(Properties) - Method in class xdoclet.tagshandler.IdTagsHandler: Generates an id attribute based on the given tag values.
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.
ifClassTagValueNotEquals(String, Properties) - Method in class xdoclet.tagshandler.ClassTagsHandler: 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.
ifConfigParamGreaterOrEquals(String, Properties) - Method in class xdoclet.tagshandler.ConfigTagsHandler: Evaluate the body if the value of the configuration parameter is greater or equal to value.
ifConfigParamGreaterOrEquals_Impl(Properties) - Method in class xdoclet.tagshandler.ConfigTagsHandler: 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.
ifConfigParamNotGreaterOrEquals(String, Properties) - Method in class xdoclet.tagshandler.ConfigTagsHandler: Evaluate the body if the value of the configuration parameter is not greater or equal to value.
ifConstructorTagValueEquals(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Evaluates the body if value for the constructor tag equals the specified value.
ifConstructorTagValueNotEquals(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: 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.
ifDoesntHaveConstructor(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Evaluate the body if current class doesn't have a constructor with the specified name+parameters.
ifDoesntHaveConstructorTag(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: 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.
ifHasConstructorTag(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: 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.
ifHasGetMethodWithTag(String, Properties) - Method in class xdoclet.tagshandler.PropertyTagsHandler: 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.
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.
ifHasParams(String, Properties) - Method in class xdoclet.tagshandler.ParameterTagsHandler: Evaluates the body of the tag if current method/constructor has parameters.
ifHasSetMethodWithTag(String, Properties) - Method in class xdoclet.tagshandler.PropertyTagsHandler: 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.
ifIsOfTypeImpl(String, Properties) - Method in class xdoclet.tagshandler.MethodTagsHandler
ifIsOfType_Impl(String, Properties, boolean) - Method in class xdoclet.tagshandler.TypeTagsHandler: Implementation of ifIsOfType and ifIsNotOfType tags.
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.
ifMethodTagValueNotEquals(String, Properties) - Method in class xdoclet.tagshandler.MethodTagsHandler: 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.
implementationClass - Variable in class xdoclet.loader.SubTaskDefinition
importedList(Properties) - Method in class xdoclet.tagshandler.ClassTagsHandler: Deprecated. Make sure the template file uses full qualified class names everywhere instead.
init(XJavaDoc) - Method in class xdoclet.SubTask: Initializes SubTask.
init(XJavaDoc) - Method in class xdoclet.TemplateSubTask: Describe what the method does
init() - Method in class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask: Initialize internal instance of XMLCatalog
initClasspath(Class) - Static method in class xdoclet.loader.ModuleFinder: Initialises the classpath.
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
invokeContentMethod(String, Properties, String, int) - Method in class xdoclet.template.TemplateEngine: Invokes content tag implementation method named cmd with the specified set of attributes.
invokeContentMethod(String, Properties, String, int) - Method in class xdoclet.template.TemplateParser: Describe what the method does
invokeMethod(String, Object[], Object[], String, int) - Method in class xdoclet.template.TemplateEngine: 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.
isGenerationNeeded(XClass, File, boolean) - Method in class xdoclet.GenerationManager: Test if a Java source mmust be generated or not depending of timestamp of elements involved.
isGenerationNeeded(File) - Method in class xdoclet.GenerationManager: 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.
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
isGuessGenerationNeeded() - Method in class xdoclet.GenerationManager: 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.
isPackageSubstitutionInheritanceSupported() - Method in class xdoclet.TemplateSubTask: By default supports, but some subtasks may not support because global packageSubstitution is for public interfaces/classes, not good for impl classes.
isPrefixWithPackageStructure() - Method in class xdoclet.TemplateSubTask: 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 variable 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 variable in class xdoclet.template.PrettyPrintWriter: Convenience variable for printing and matching line separators in a system portable manner.
LINE_SEPARATOR_LEN - Static variable in class xdoclet.template.PrettyPrintWriter
LOAD_MODULE_ERROR - Static variable in class xdoclet.loader.LoaderMessages
LoaderMessages - class xdoclet.loader.LoaderMessages.
LoaderMessages() - Constructor for class xdoclet.loader.LoaderMessages
LogUtil - class xdoclet.util.LogUtil.
LogUtil() - Constructor for class xdoclet.util.LogUtil

M

MANDATORY_TAG_PARAM_MISSING_CLASS - Static variable in class xdoclet.XDocletMessages
MANDATORY_TAG_PARAM_MISSING_CONSTRUCTOR - Static variable in class xdoclet.XDocletMessages
MANDATORY_TAG_PARAM_MISSING_FIELD - Static variable in class xdoclet.XDocletMessages
MANDATORY_TAG_PARAM_MISSING_METHOD - Static variable in class xdoclet.XDocletMessages
MANDATORY_TAG_PARAM_MISSING_TEMPLATE - Static variable in class xdoclet.XDocletMessages
METHOD_FAILED - Static variable in class xdoclet.XDocletMessages
METHOD_NOT_FOUND - Static variable in class xdoclet.XDocletMessages
MergeTagsHandler - class xdoclet.tagshandler.MergeTagsHandler.
MergeTagsHandler() - Constructor for class xdoclet.tagshandler.MergeTagsHandler
MethodTagsHandler - class xdoclet.tagshandler.MethodTagsHandler.
MethodTagsHandler() - Constructor for class xdoclet.tagshandler.MethodTagsHandler
ModuleFinder - class xdoclet.loader.ModuleFinder.: Finds xdoclet modules.
ModuleFinder() - Constructor for class xdoclet.loader.ModuleFinder
ModulesGrandBuilderTask - class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask.: Loops over all modules and builds each one.
ModulesGrandBuilderTask() - Constructor for class xdoclet.ant.modulesbuilder.ModulesGrandBuilderTask
makeCopyOfArray(Object[]) - Static method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: Used to protect returned arrays from being modified (sorted, reordered for example).
mandatoryParamNotFound(XDoc, String, String) - Static method in class xdoclet.XDocletTagSupport: Throws an XDocletException exception to stop the build process.
mandatoryTemplateTagParamNotFound(String, String) - Method in class xdoclet.XDocletTagSupport: Throws an XDocletException exception to stop the build process.
matchPattern - Static variable 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.
matchesGenerationRules(XClass) - Method in class xdoclet.TemplateSubTask: Returns true if output not already generated for clazz, and is of the specified type and has the specified class tag; false otherwise.
memberComment(Properties, int) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler
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.
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.
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(int) - Method in class xdoclet.XDocletTagSupport: Return the modifiers (static, private, etc.) for the current program element of the specified type.
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.

N

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

O

OBSOLETE_TASK_ATTRIBUTE - Static variable in class xdoclet.XDocletMessages
ONLY_CALL_CONSTRUCTOR_NOT_NULL - Static variable in class xdoclet.tagshandler.XDocletTagshandlerMessages
ONLY_CALL_FIELD_NOT_NULL - Static variable in class xdoclet.tagshandler.XDocletTagshandlerMessages
ONLY_CALL_METHOD_NOT_NULL - Static variable in class xdoclet.tagshandler.XDocletTagshandlerMessages
out - Variable in class xdoclet.template.TemplateEngine: The PrintWriter used for outputing the generated stuff.
output - Variable 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

PARAMETER_DELIMITER - Static variable in class xdoclet.XDocletTagSupport: Default delimiter used inside a xdoclet tag attribute.
PARAMETER_MISSING_OR_EMPTY - Static variable in class xdoclet.XDocletMessages
PARSING_XDOCLET_XML - Static variable in class xdoclet.loader.LoaderMessages
PROPERTY_MISSING - Static variable in class xdoclet.ant.XDocletAntMessages
PackageTagsHandler - class xdoclet.tagshandler.PackageTagsHandler.: Tags which manipulate package names and packages, including substitutions.
PackageTagsHandler() - Constructor for class xdoclet.tagshandler.PackageTagsHandler
PackageTagsHandler.PackageSubstitution - class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution.: 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.PackageSubstitution() - Constructor for class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution
ParameterTagsHandler - class xdoclet.tagshandler.ParameterTagsHandler.
ParameterTagsHandler() - Constructor for class xdoclet.tagshandler.ParameterTagsHandler
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
PropertyTagsHandler - class xdoclet.tagshandler.PropertyTagsHandler.: PropertyTagsHandler.java
PropertyTagsHandler() - Constructor for class xdoclet.tagshandler.PropertyTagsHandler
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(XPackage) - Static method in class xdoclet.tagshandler.PackageTagsHandler: Returns a package name as a path, after applying any substitutions.
packageNameAsPathFor(String) - 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.
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.
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.
parentTaskClass - Variable in class xdoclet.loader.SubTaskDefinition
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.
print(String) - Method in class xdoclet.template.TemplateEngine: Describe what the method does
println() - Method in class xdoclet.template.PrettyPrintWriter
process(DocletTask, SubTask[]) - Method in class xdoclet.XDocletFacade
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.
propertyName() - Method in class xdoclet.tagshandler.MethodTagsHandler: Returns the property name extracted from the current method name.
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

REGISTERING_MODULES - Static variable in class xdoclet.loader.LoaderMessages
RUNNING_FAILED - Static variable in class xdoclet.XDocletMessages
RUNNING_TASKNAME - Static variable in class xdoclet.XDocletMessages
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
readerClassName - Variable in class xdoclet.util.XmlValidator
registerDTD(String, URL) - Method in class xdoclet.util.XmlValidator: Registers a local DTD document by its public id.
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

S

SKIP_NO_XDOCLET_XML - Static variable in class xdoclet.loader.LoaderMessages
SubTask - class xdoclet.SubTask.: An abstract base class for all sub-tasks.
SubTask() - Constructor for class xdoclet.SubTask
SubTaskDefinition - class xdoclet.loader.SubTaskDefinition.
SubTaskDefinition(String, String, String) - Constructor for class xdoclet.loader.SubTaskDefinition
schema() - Method in class xdoclet.tagshandler.XmlTagsHandler: Returns the schema for an XML template.
setAcceptAbstractClasses(boolean) - Method in class xdoclet.TemplateSubTask: Indicates whether or not to generate for abstract classes.
setAcceptInterfaces(boolean) - Method in class xdoclet.TemplateSubTask: Indicates whether or not to generate for interfaces.
setActiveSubTask(SubTask) - Method in class xdoclet.DocletContext: 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.
setCurrentConstructor(XConstructor) - Method in class xdoclet.DocletSupport: Sets the CurrentConstructor attribute of the DocletSupport object
setCurrentConstructor(XConstructor) - Static method in class xdoclet.XDocletTagSupport: Set the current constructor.
setCurrentConstructor(String, Properties) - Method in class xdoclet.tagshandler.ConstructorTagsHandler: Evaluate the body if current class has a constructor with the specified name+parameters.
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(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.
setCurrentMethod(String, Properties) - Method in class xdoclet.tagshandler.MethodTagsHandler: Evaluate the body if current class has a method with the specified name+parameters.
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.
setDestinationFile(String) - Method in class xdoclet.TemplateSubTask: 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.
setDynamicAttribute(String, String) - Method in class xdoclet.DocletTask
setEngine(TemplateEngine) - Method in class xdoclet.TemplateSubTask: Sets the Engine attribute of the TemplateSubTask object
setExcludePackageNames(String) - Method in class xdoclet.DocletTask: Deprecated.
setExcludedTags(String) - Method in class xdoclet.DocletTask: Deprecated.
setExtent(TemplateSubTask.ExtentTypes) - Method in class xdoclet.TemplateSubTask: 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.
setGenerationManager(GenerationManager) - Method in class xdoclet.TemplateSubTask: Sets the GenerationManager attribute of the TemplateSubTask object
setGuessGenerationNeeded(boolean) - Method in class xdoclet.GenerationManager: Sets the GuessGenerationNeeded attribute of the GenerationManager object.
setHavingClassTag(String) - Method in class xdoclet.TemplateSubTask: Sets the HavingClassTag attribute of the TemplateSubTask object
setInstance(XmlValidator) - Static method in class xdoclet.util.XmlValidator: Sets the Instance attribute of the XmlValidator class
setMatchValue(String, Properties) - Method in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: 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: Deprecated.
setPackageSubstitutionInheritanceSupported(boolean) - Method in class xdoclet.TemplateSubTask: Indicates whether or not package substitution should be inherited
setPackageSubstitutions(List) - Method in class xdoclet.DocletTask: Sets the PackageSubstitutions attribute of the EjbDocletTask object
setPackageSubstitutions(ArrayList) - Method in class xdoclet.TemplateSubTask: Sets the PackageSubstitutions attribute of the TemplateSubTask object
setPackages(String) - Method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution: Sets the Packages attribute of the PackageSubstitution object
setPrefixWithPackageStructure(boolean) - Method in class xdoclet.TemplateSubTask: 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.
setSingleInstance(DocletContext) - Static method in class xdoclet.DocletContext: Sets the SingleInstance attribute of the DocletContext class
setSubTaskClassName(String) - Method in class xdoclet.TemplateSubTask: 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.
setSubstituteWith(String) - Method in class xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution: Sets the SubstituteWith attribute of the PackageSubstitution object
setSystemId(String) - Method in class xdoclet.XmlSubTask: The SYSTEM ID of the DTD to which the generated document should conform.
setTagHandlerFor(String, TemplateTagHandler) - Method in class xdoclet.template.TemplateEngine: 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.TemplateSubTask: This method should be called to set a template file programmatically.
setTemplateURL(URL) - Method in class xdoclet.template.TemplateEngine: A config parameter settable from Ant build file.
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.
setWriter(PrettyPrintWriter) - Method in class xdoclet.template.TemplateEngine: 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.
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.
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(XJavaDoc) - Method in class xdoclet.XDocletMain: Starts XDoclet
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.
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.
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

TAGDEF_COULDNT_DEF_HANDLER - Static variable in class xdoclet.tagshandler.XDocletTagshandlerMessages
TAGDEF_ILLEGALACCESS_EXCEPTION - Static variable in class xdoclet.tagshandler.XDocletTagshandlerMessages
TAGDEF_INSTANTIATION_EXCEPTION - Static variable in class xdoclet.tagshandler.XDocletTagshandlerMessages
TAGVALUE_NULL - Static variable in class xdoclet.XDocletMessages
TAG_MALFORMED_VALUE - Static variable in class xdoclet.XDocletMessages
TAG_MAPPINGS_FILE - Static variable in class xdoclet.template.TemplateEngine
TAG_MISSING_EQUALS - Static variable in class xdoclet.XDocletMessages
TAG_MUST_ESCAPE_QUOTES - Static variable in class xdoclet.XDocletMessages
TAG_MUST_INCLUDE_A_PROPERTY - Static variable in class xdoclet.XDocletMessages
TAG_NO_CLOSING_QUOTE - Static variable in class xdoclet.XDocletMessages
TAG_QUOTE_EXPECTED - Static variable in class xdoclet.XDocletMessages
TEMPLATE_CLASSNOTFOUNDEXCEPTION - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_CLOSE_TAG_MISSING - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_CORRESPONDING_TAG_MISSING - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_COULDNT_LOAD_MAPPINGS - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_EQUALS_EXPECTED - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_ERROR_WRITING_OUTPUT - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_GT_EXPECTED - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_ILLEGALACCESSEXCEPTION - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_INSTANTIATIONEXCEPTION - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_INVOKE_METHOD_FAILED - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_IOEXCEPTION - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_NOCLASSDEFFOUNDERROR - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_NOT_FOUND - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_NO_SUCH_METHOD - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_NO_TAGHANDLER - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_PARAMETER_MISSING - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_QUOTE_EXPECTED - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_SYNTAX_ERROR - Static variable in class xdoclet.template.XDocletTemplateMessages
TEMPLATE_TAGNAME_IS_NULL - Static variable in class xdoclet.XDocletMessages
TYPE_CONCRETE_TYPE - Static variable in class xdoclet.tagshandler.TypeTagsHandler: Used by isOfType.
TYPE_HIERARCHY - Static variable in class xdoclet.tagshandler.TypeTagsHandler: Used by isOfType.
TYPE_SUPERCLASS - Static variable in class xdoclet.tagshandler.TypeTagsHandler: Used by isOfType.
TagDefTagsHandler - class xdoclet.tagshandler.TagDefTagsHandler.: The implementation of TagDef template tag.
TagDefTagsHandler() - Constructor for class xdoclet.tagshandler.TagDefTagsHandler
TagHandlerDefinition - class xdoclet.loader.TagHandlerDefinition.
TagHandlerDefinition(String, String) - Constructor for class xdoclet.loader.TagHandlerDefinition: Describe what the TagHandlerDefinition constructor does
TemplateEngine - class xdoclet.template.TemplateEngine.: The default template engine used by derived SubTasks.
TemplateEngine() - Constructor for class xdoclet.template.TemplateEngine
TemplateException - exception xdoclet.template.TemplateException.
TemplateException(String) - Constructor for class xdoclet.template.TemplateException: Describe what the TemplateException constructor does
TemplateException(Exception, 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.
TemplateSubTask - class xdoclet.TemplateSubTask.: Generic subtask for processing a user-supplied template.
TemplateSubTask() - Constructor for class xdoclet.TemplateSubTask
TemplateSubTask.ExtentTypes - class xdoclet.TemplateSubTask.ExtentTypes.
TemplateSubTask.ExtentTypes() - Constructor for class xdoclet.TemplateSubTask.ExtentTypes
TemplateSubTask.OfType - class xdoclet.TemplateSubTask.OfType.: Applicable only to per class output generation.
TemplateSubTask.OfType() - Constructor for class xdoclet.TemplateSubTask.OfType
TemplateTagHandler - class xdoclet.template.TemplateTagHandler.
TemplateTagHandler() - Constructor for class xdoclet.template.TemplateTagHandler
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.
TranslatorTagsHandler() - Constructor for class xdoclet.tagshandler.TranslatorTagsHandler
TypeConversionUtil - class xdoclet.util.TypeConversionUtil.
TypeConversionUtil() - Constructor for class xdoclet.util.TypeConversionUtil
TypeTagsHandler - class xdoclet.tagshandler.TypeTagsHandler.: Simple tag support class.
TypeTagsHandler() - Constructor for class xdoclet.tagshandler.TypeTagsHandler
tagDef(Properties) - Method in class xdoclet.tagshandler.TagDefTagsHandler: Defines a template tag handler for a template tag to TemplateEngine.
tagTokenizer - Static variable in class xdoclet.tagshandler.AbstractProgramElementTagsHandler: The StringTokenizer object doing the tokenization.
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.
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(char[], int, int) - Method in class xdoclet.template.PrettyPrintWriter: Describe what the method does
write(int) - Method in class xdoclet.template.PrettyPrintWriter
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_FAILED - Static variable in class xdoclet.XDocletMessages
XDOCLET_HEAD - Static variable in class xdoclet.template.TemplateEngine
XDOCLET_HEAD_LEN - Static variable in class xdoclet.template.TemplateEngine
XDOCLET_PREFIX - Static variable in class xdoclet.template.TemplateEngine
XDOCLET_TAIL - Static variable in class xdoclet.template.TemplateEngine
XDOCLET_TAIL_LEN - Static variable in class xdoclet.template.TemplateEngine
XDOCLET_VERSION - Static variable in class xdoclet.DocletTask
XDocletAntMessages - class xdoclet.ant.XDocletAntMessages.
XDocletAntMessages() - Constructor for class xdoclet.ant.XDocletAntMessages
XDocletException - exception xdoclet.XDocletException.
XDocletException(String) - Constructor for class xdoclet.XDocletException: Describe what the XDocletException constructor does
XDocletException(Exception, String) - Constructor for class xdoclet.XDocletException: Describe what the XDocletException constructor does
XDocletFacade - class xdoclet.XDocletFacade.
XDocletFacade() - Constructor for class xdoclet.XDocletFacade
XDocletFacadeTest - class xdoclet.XDocletFacadeTest.
XDocletFacadeTest(String) - Constructor for class xdoclet.XDocletFacadeTest
XDocletMain - class xdoclet.XDocletMain.: This class serves as an entry-point for starting XDoclet.
XDocletMain() - Constructor for class xdoclet.XDocletMain
XDocletMessages - class xdoclet.XDocletMessages.: All messages resource keys should be defined in a Messages class, per package, as constants.
XDocletMessages() - Constructor for class xdoclet.XDocletMessages
XDocletModule - class xdoclet.loader.XDocletModule.: This is an object view of the data in xdoclet.xml
XDocletModule() - Constructor for class xdoclet.loader.XDocletModule
XDocletTagSupport - class xdoclet.XDocletTagSupport.: Derives from TemplateTagHandler and adds handy support methods for working with Javadoc Doclet classes.
XDocletTagSupport() - Constructor for class xdoclet.XDocletTagSupport
XDocletTagshandlerMessages - class xdoclet.tagshandler.XDocletTagshandlerMessages.
XDocletTagshandlerMessages() - Constructor for class xdoclet.tagshandler.XDocletTagshandlerMessages
XDocletTemplateMessages - class xdoclet.template.XDocletTemplateMessages.
XDocletTemplateMessages() - Constructor for class xdoclet.template.XDocletTemplateMessages
XDocletUtilMessages - class xdoclet.util.XDocletUtilMessages.
XDocletUtilMessages() - Constructor for class xdoclet.util.XDocletUtilMessages
XDocletXmlParserTest - class xdoclet.loader.XDocletXmlParserTest.
XDocletXmlParserTest(String) - Constructor for class xdoclet.loader.XDocletXmlParserTest
XmlSubTask - class xdoclet.XmlSubTask.: Generic subtask for processing a user-supplied template, to generate an XML document.
XmlSubTask() - Constructor for class xdoclet.XmlSubTask
XmlTagsHandler - class xdoclet.tagshandler.XmlTagsHandler.: XML template support tags.
XmlTagsHandler() - Constructor for class xdoclet.tagshandler.XmlTagsHandler
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
xdoclet - package xdoclet
xdoclet.ant - package xdoclet.ant
xdoclet.ant.modulesbuilder - package xdoclet.ant.modulesbuilder
xdoclet.loader - package xdoclet.loader: This package implements the functionality required to load drop-in modules dynamically.
xdoclet.tagshandler - package xdoclet.tagshandler
xdoclet.template - package xdoclet.template
xdoclet.util - package xdoclet.util
xmlReader - Variable in class xdoclet.util.XmlValidator: XMLReader used for validation

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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

http://xdoclet.sourceforge.net/

PREV NEXT

FRAMES NO FRAMES