Describe what the method does
Throws BuildException if a specific class is not on the CP.
A utility method used by firstSentenceDescription to replace end of line by space.
The comment for the current class.
The javadoc comment tags for the current class (plus xdoclet-generated).
The text of the javadoc comment for the current class.
Returns the not-fully-qualified name of the current class without the package name.
Returns the not-full-qualified name of the full-qualified class name specified in the body of this tag.
Tags relating to classes being processed and class-level attributes.
Iterates over all class tags with the specified tagName and evaluates the body of the tag for each class tag.
Sets the value of match variable.
Closes the output stream and writes the last line.
This tag simply output nothing.
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>
Returns the values of a configuration parameter with the name paramName.
The comment for the current constructor.
Returns the name of the current constructor.
Iterates over all constructor tags with the specified tagName for the current constructor probably inside of a
forAllConstructorTags body.
Describe what the method does
Describe what the method does
Describe what the method does
Create a DTD location record; optional.
Returns the current constructor name.
Returns the current method name.
The current method's current parameter.
The currentMethodParamTag
holds the current ParamTag corresponding to the current Parameter.
return name of parameter currently being iterated - ugly hack...
Returns current token inside forAllClassTagTokens.
The comment for the current field.
Returns the name of the current field.
Iterates over all field tags with the specified tagName for the current field probably inside of a
forAllFieldTags body.
Returns the type of the current field.
A utility class for handling common filing operations.
Describe what the method does
Returns a List of XDocletModule objects
Return first sentence of standard javadoc of current class.
Return standard javadoc of current constructor.
Return standard javadoc of current field.
Describe what the method does
Return standard javadoc of current method.
Loops through all constructors for all classes after first sorting all the constructors.
Iterates over all classes loaded by xjavadoc and evaluates the body of the tag for each class.
Loops through all methods for all classes after first sorting all the methods.
Iterates over all tags of current class with the name tagName and evaluates the body of the tag for each method.
Iterates over all tokens in specified class tag with the name tagName and evaluates the body for every token.
Evaluate the body for all configuration parameters with the name paramName.
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.
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.
Iterates over all fields of current class and evaluates the body of the tag for each field.
Iterates over all tags of current field and evaluates the body of the tag for each field.
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
Iterates over all parameters of current method and evaluates the body of the tag for each method.
Iterates over all methods of current class and evaluates the body of the tag for each method.
Iterates over all tags of current method and evaluates the body of the tag for each method.
Iterates over all tokens in current method tag with the name tagName and evaluates the body for every token.
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.
Returns the full-qualified name of the current class.
Returns the full-qualified name of the superclass of the current class.
Returns the fully-qualified transformed name of the current class with package name.
The main template parsing/processing/running logic.
In this class, this method does not -generate- anything but only parse the files.
A utility method used for generating the dest_file based on template_file template file.
Processed template for clazz and generates output file for clazz.
Processes the file specified in merge_file_pattern that has the text content contents.
Verify if the generation is needed for Java files and Xml files based templates.
Describe what the GenerationManager constructor does
Gets the ActiveSubTask attribute of the DocletContext object
Utility method to get classes for iteration used by various methods.
Returns the capitalized name of the current field.
Returns the not-full-qualified name of the specified class without the package name.
Returns the not-full-qualified name of the specified class without the package name.
Gets the ConfigParam attribute of the DocletContext object
Returns the value for the specified configuration parameter.
Gets the ConfigParams attribute of the DocletTask object
Gets the ConfigParams attribute of the SubTask object
Gets the ConfigParams attribute of the DocletTask object
A utility method that deleges the call to DocletContext.getSingleInstance().
Peeks and return the current class from top of currentClassStack stack.
Provides the current class in the XDoclet build, or null if there is no current class.
Gets the CurrentClassTag attribute of the DocletSupport class
Gets the CurrentConfigParamIndex attribute of the ConfigTagsHandler class
Returns current constructor.
Provides the current constructor in the XDoclet build, or null if there is no current constructor.
Provides the current field in the XDoclet build, or null if there is no current field.
Gets the CurrentFieldTag attribute of the DocletSupport field
Gets the CurrentLineNum attribute of the TemplateEngine object
Provides the current method in the XDoclet build, or null if there is no current method.
Gets the CurrentMethodTag attribute of the DocletSupport class
Provides the current package in the XDoclet build, or null if there is no current package.
This method is for backward compatiblity only.
Gets the DestDir attribute of the DocletContext object
Gets the DestDir attribute of the DocletTask object
Gets the DestDir attribute of the SubTask object
Gets the DestinationFile attribute of the TemplateSubTask object
Gets the DtdURL attribute of the XmlSubTask object.
Gets the Engine attribute of the TemplateSubTask object
Gets the Engine attribute of the TemplateTagHandler object.
Gets the EngineInstance attribute of the TemplateEngine class
Gets the ExcludedTags attribute of the DocletContext object
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.
Gets the Extent attribute of the TemplateSubTask object
Gets the FieldTypeFor attribute of the FieldTagsHandler class
Returns the full-qualified name of the current class with the package name.
Returns the full-qualified name of the specified class with the package name.
Returns the full-qualified name of the superclass of the specified class.
Returns class name for the generated file.
Gets the HavingClassTag attribute of the TemplateSubTask object
A utility method to get the blank space characters used for indenting comments.
Gets the Instance attribute of the DocletContext class
Gets the Instance attribute of the XmlValidator class
Loops over the template content till reaching tillIndex index and returns the number of lines it has encountered.
Returns an instance of Jakarta Commons Log object.
Gets the MergeDir attribute of the DocletContext object
Gets the MergeDir attribute of the DocletTask object
Gets the MergeDir attribute of the SubTask object
A utility method used for merging a file used by tag.
Return the list of merge files involved in the generation.
Merge with modified SubTask.methodNameWithoutPrefix
Gets the Name attribute of the ConfigParameter object
Returns a Set of Strings that represent the registered namespaces
Gets the NestedException attribute of the TemplateException object
Get the newest Jar file on the classpath.
Gets the OfType attribute of the TemplateSubTask object
Gets the Output attribute of the TemplateEngine object
Gets a package name with any subsitutions applied.
Apply package substitutions.
Gets the name of a package, optionally applying any substitutions.
Gets the Packages attribute of the PackageSubstitution object
Gets the PackageSubstitutions attribute of the EjbDocletTask object
Gets the PackageSubstitutions attribute of the TemplateSubTask object
Gets any PackageSubstitutions defined for a specified subtask.
Gets the ParserInstance attribute of the TemplateParser class
Gets the PrintStackTrace attribute of the XDocletException object
Gets the Properties attribute of the DocletContext object
Gets the Property attribute of the DocletContext object
Gets the PropertyNameFor attribute of the MethodTagsHandler class
Gets the PublicId attribute of the XmlSubTask object.
Gets the Schema attribute of the XmlSubTask object.
Gets the String attribute of the Translator class.
Gets the String attribute of the Translator class.
Returns a localized text string.
Gets the String attribute of the Translator class.
Gets the String attribute of the Translator class.
Gets the SubstituteWith attribute of the PackageSubstitution object
Gets the SubTaskBy attribute of the DocletContext object
Gets the SubTaskClassName attribute of the TemplateSubTask object
Gets the SubTaskName attribute of the SubTask object
Gets the SubTasks attribute of the DocletContext object
Gets the SubTasks attribute of the DocletTask object
Gets the SystemId attribute of the XmlSubTask object.
Get the tag handler for the prefix.
Gets the TagValue attribute of the XDocletTagSupport class
Return the Value of a tag specified in a Properties object.
Returns current template URL.
Gets the TemplateURL attribute of the TemplateSubTask object
Returns the getter method name for the current method by prefixing the method name with the proper getter prefix.
Returns 'get' or 'is' getter prefix part of the current method.
Gets the URLContent attribute of the FileManager class
return the useAny attribute.
Gets the UseIds attribute of the XmlSubTask object.
Gets the Value attribute of the ConfigParameter object
Searches for the XExecutableMember of the member with name methodName and returns it.
Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object
Searches for the XMethod of the method with name methodName and returns it.
Gets the Xmlencoding attribute of the XmlSubTask object.
Generates an id attribute based on the given tag values.
Evaluates the body if value for the class tag equals the specified value.
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.
Evaluate the body if the value of the configuration parameter equals value.
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.
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.
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.
Evaluates the body if current field doesnt have any tags with the specified name.
Evaluate the body if current class doesn't have a method with the specified name+parameters.
Evaluates the body if current method doesn't have at least one tag with the specified name.
Evaluates the body block if current method doesn't return void.
Evaluate the body block if current method doesn't throw the exceptions specified in the exceptions
attribute.
Evaluates the body if value for the field tag equals the specified value.
Evaluates the body if current class has at least one tag with the specified name.
Evaluates the body if config parameter specified is not null.
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.
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.
Evaluate the body if current class has a method with the specified name+parameters.
Evaluates the body block if current method has a javadoc comment.
Evaluates the body if current method has at least one tag with the specified name.
Evaluates the body of the tag if current method/constructor has parameters.
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.
Evaluate the body block if current method is abstract.
Evaluate the body block if current class is abstract.
Evaluate the body block if current class is not abstract.
Evaluates the body if the specified method (or current method if none is supplied) is a getter method.
Evaluates the body block if current method is not abstract.
Evaluates the body if the return type of the current method doesn't equal the specified value.
Evaluate the body block if the entity is not of the specified type.
Evaluate the body block if the value is not of a primitive type.
Evaluate the body block if the value is not of a primitive array type.
Evaluate the body block if the value is of a primitive type or String.
Evaluates the body if the return type of the current method equals the specified value.
Evaluate the body block if the entity is of the specified type.
Implementation of ifIsOfType
and ifIsNotOfType
tags.
Evaluate the body block if the value is of a primitive type.
Evaluate the body block if the value is of a primitive array type.
Evaluate the body block if the value is of a primitive type or String.
Evaluates the body if the current method has public visibility.
Evaluates the body if the specified method (or current method if none is supplied) is a setter method.
Evaluates the body if the file exists specified by the "file" attribute.
Evaluates the body if method name equals to the specified value.
Evaluates the body if method name equals to the specified value.
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.
Evaluate the body block if current method returns void.
Evaluate the body block if current method throws the exceptions specified in the exceptions
attribute.
Iterates over all imported classes and packages imported in the current class and returns the list.
Initialize internal instance of XMLCatalog
Describe what the method does
Initialises the classpath.
Describe what the method does
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.
Returns true if the clazz generated by xdoclet.
Gets the Force attribute of the DocletContext object.
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.
Returns true if the str string starts with a getter prefix ("get" or "is").
Gets the GuessGenerationNeeded attribute of the GenerationManager object
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
Returns true if name is a primitive type and is an array (ends with [])
Returns true if name is a primitive type, in that case name contains the string "int"/"float"/etc.
Returns true if the str string starts with "set" prefix.
Gets the SubTaskDefined attribute of the DocletContext object
A utility method used by ifMethodTagValueEquals/ifMethodTagValueNotEquals and
ifClassTagValueEquals/ifClassTagValueNotEquals, return true if the value of the tag/XParameter equals with value.
Gets the ValidateXML attribute of the XmlSubTask object.
Gets the Verbose attribute of the DocletContext object.
Gets the Verbose attribute of the DocletTask object.
Used to protect returned arrays from being modified (sorted, reordered for example).
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.
Template can use matchPattern as a place where they can put volatile variable.
Returns the value of match variable.
Merge contents of the file designated by the file parameter and evaluates the body if the file is not found.
The comment for the current method.
Returns the name of the current method.
Returns the name of the current method without the first three characters.
The methodParamDescription
method returns the comment text associated with the ParamTag for the
current Parameter
Returns the name of the current method parameter, current method parameter is set inside a forAllMethodParams tag
in each iteration.
Returns the type of the current method parameter, current method parameter is set inside a forAllMethodParams tag
in each iteration.
Iterates over all method tags with the specified tagName for the current method probably inside of a
forAllMethodTags body.
Returns the return type of the current method.
The current class' modifiers.
Describe what the method does
Describe what the method does
Any modifiers (static, volatile, etc.) for the current method.
Return the modifiers (static, private, etc.) for the current program element of the specified type.
Loops over all modules and builds each one.
Returns the current package name.
Returns the current package name as a path.
Returns a package name as a path, after applying any substitutions.
Returns a package name as a path, after applying any substitutions.
Returns a package name as a path, without applying any substitutions.
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.
Tags which manipulate package names and packages, including substitutions.
Default delimiter used inside a xdoclet tag attribute.
Iterates over all parameters in current method and returns a string containing definition of all those
parameters.
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.
Popes current class from top currentClassStack stack.
Pop the current class off the top of the class stack.
Generates an id attribute based on the given prefix.
Extends the PrintWriter class by adding the possibility of emiting empty lines.
Describe what the PrettyPrintWriter constructor does
Describe what the PrettyPrintWriter constructor does
Describe what the PrettyPrintWriter constructor does
Describe what the method does
Subclasses should override this method and return true if they want startProcessPerClass() to process inner
classes too.
Returns the values of a configuration parameter with the name paramName.
Returns the property name extracted from the current method name.
The propertyTypeWithTag
method figures out the type for the current property with tag by looking for
a getter, then a setter.
Returns the DTD's public ID for an XML template.
Pushes the class specified by value parameter to top of stack making it the current class.
Pushes class clazz to top of currentClassStack stack, making it effectively the current class.
Push the specified class to the top of the current class stack making it effectively the current class.
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
Add some JavaDoc tags (or comments) to the generated classes.
Sets current class to clazz by clearing currentClassStack stack and pushing clazz into top of it.
Sets current class to clazz
by clearing currentClassStack
stack and pushing clazz
into top of it.
Sets the CurrentClassTag attribute of the DocletSupport class
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.
Sets the CurrentField attribute of the DocletSupport object
Sets the CurrentFieldTag attribute of the DocletSupport field
Sets the current field tag.
Sets the CurrentLineNum attribute of the TemplateEngine object
Evaluate the body if current class has a method with the specified name+parameters.
Sets the CurrentMethod attribute of the DocletSupport object
Sets the CurrentMethodTag attribute of the DocletSupport class
Sets the current method tag.
Destination directory for output files
Sets the directory where the generated file(s) will be written.
The destination file name.
Sets the DtdURL attribute of the XmlSubTask object.
Sets the Engine attribute of the TemplateSubTask object
Specify tags that should not be automatically written to output files.
Sets the ExcludePackageNames attribute of the DocletTask object
You can control the extent in which the type search occurs.
Sets the ExtentValue attribute of the TemplateSubTask object
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.
Sets the HavingClassTag attribute of the TemplateSubTask object
Sets the Instance attribute of the XmlValidator class
Sets the value of match variable.
Directory where subtasks will look for files to be merged with generated files.
Specifies the location of the merge directory.
The name of the parameter.
Sets the Output attribute of the TemplateEngine object
Sets the PackageNames attribute of the DocletTask object
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
Sets the PackageSubstitutions attribute of the EjbDocletTask object
Indicates whether or not to prefix with package structure.
The PUBLIC ID of the DTD to which the generated document should conform.
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
Sets an optional name for the subtask that will be seen in XDoclet's debug messages.
The SYSTEM ID of the DTD to which the generated document should conform.
Sets the TagHandlerFor attribute of the TemplateEngine object
set the name of the target to be called in each of the modules' build files
Sets the name of the template file to use for generation
A config parameter settable from Ant build file.
This method should be called to set a template file programmatically.
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.
Sets the useFirst attribute
If this attribute is set to true, XDoclet will generate id attributes in the XML document.
If this is set to true, the generated XML will be validated against its DTD or XML Schema.
The value of the parameter.
Sets the Verbose attribute of the DocletTask object.
Sets the Writer attribute of the TemplateEngine object
The encoding of the produced xml file.
Skips whitespaces, starting from index i till the first non-whitespace character or end of template and returns
the new index.
A utility method used for generating the dest_file based on template_file template file.
A utility method used for generating the dest_file based on template_file template file.
Describe what the method does
Describe what the method does
Describe what the method does
A utility method for converting a string to a boolean.
An abstract base class for all sub-tasks.
Returns the symbolic name of the current class.
Returns the DTD's system ID for an XML template.