Frames | No Frames |
Methods which throw type xdoclet.XDocletException | |
String | ClassTagsHandler.classComment(Properties attributes) The comment for the current class. |
String | ClassTagsHandler.classCommentTags(Properties attributes) The javadoc comment tags for the current class (plus xdoclet-generated). |
String | ClassTagsHandler.classCommentText(Properties attributes) The text of the javadoc comment for the current class. |
String | Returns the not-fully-qualified name of the current class without the package name. |
void | ClassTagsHandler.classOf(String template) Returns the not-full-qualified name of the full-qualified class name specified in the body of this tag. |
String | ClassTagsHandler.classTagValue(Properties attributes) Iterates over all class tags with the specified tagName and evaluates the body of the tag for each class tag. |
String | ClassTagsHandler.classTagValueMatch(Properties attributes) Sets the value of match variable. |
String | ConfigTagsHandler.configParameterValue(Properties attributes) Returns the values of a configuration parameter with the name paramName. |
String | ConstructorTagsHandler.constructorComment(Properties attributes) The comment for the current constructor. |
String | ConstructorTagsHandler.constructorName(Properties attributes) Returns the name of the current constructor. |
String | ConstructorTagsHandler.constructorTagValue(Properties attributes) Iterates over all constructor tags with the specified tagName for the current constructor probably inside of a
forAllConstructorTags body. |
String | Returns the current constructor name. |
String | Returns the current method name. |
String | AbstractProgramElementTagsHandler.currentToken(Properties attributes) Returns current token inside forAllClassTagTokens. |
String | ConstructorTagsHandler.exceptionList(Properties attributes) Iterates over all exceptions thrown by the current constructor and returns a string containing definition of all
those exceptions. |
String | MethodTagsHandler.exceptionList(Properties attributes) Iterates over all exceptions thrown by the current method and returns a string containing definition of all those
exceptions. |
String | AbstractProgramElementTagsHandler.exceptionList(Properties attributes, int forType) Describe what the method does
|
void | ConstructorTagsHandler.executeAndRestoreConstructor(String template, Properties attributes) Evaluate the current block, and then restore the current constructor before continuing. |
void | MethodTagsHandler.executeAndRestoreMethod(String template, Properties attributes) Evaluate the current block, and then restore the current method before continuing. |
String | FieldTagsHandler.fieldComment(Properties attributes) The comment for the current field. |
String | Returns the name of the current field. |
String | FieldTagsHandler.fieldTagValue(Properties attributes) Iterates over all field tags with the specified tagName for the current field probably inside of a
forAllFieldTags body. |
String | Returns the type of the current field. |
String | ClassTagsHandler.firstSentenceDescription(Properties attributes) Return first sentence of standard javadoc of current class. |
String | Return standard javadoc of current constructor. |
String | Return standard javadoc of current field. |
String | Describe what the method does
|
String | Return standard javadoc of current method. |
void | ConstructorTagsHandler.forAllClassConstructors(String template, Properties attributes) Loops through all constructors for all classes after first sorting all the constructors. |
void | MethodTagsHandler.forAllClassMethods(String template, Properties attributes) Loops through all methods for all classes after first sorting all the methods. |
void | ClassTagsHandler.forAllClassTagTokens(String template, Properties attributes) Iterates over all tokens in specified class tag with the name tagName and evaluates the body for every token. |
void | ClassTagsHandler.forAllClassTags(String template, Properties attributes) Iterates over all tags of current class with the name tagName and evaluates the body of the tag for each method. |
void | ClassTagsHandler.forAllClasses(String template, Properties attributes) Iterates over all classes loaded by xjavadoc and evaluates the body of the tag for each class. |
void | ConfigTagsHandler.forAllConfigParameters(String template, Properties attributes) Evaluate the body for all configuration parameters with the name paramName. |
void | ParameterTagsHandler.forAllConstructorParams(String template) Iterates over all parameters of current constructor and evaluates the body of the tag for each method. |
void | ConstructorTagsHandler.forAllConstructorTagTokens(String template, Properties attributes) Iterates over all tokens in current constructor tag with the name tagName and evaluates the body for every token. |
void | ConstructorTagsHandler.forAllConstructorTags(String template, Properties attributes) Iterates over all tags of current constructor and evaluates the body of the tag for each constructor. |
void | ConstructorTagsHandler.forAllConstructors(String template, Properties attributes) Iterates over all constructors of current class and evaluates the body of the tag for each constructor. |
void | ClassTagsHandler.forAllDistinctClassTags(String template, Properties attributes) Iterates over all tags named according to tagName in a non-duplicated manner. |
void | ClassTagsHandler.forAllDistinctClassTags(TemplateEngine engine, String template, String tagName, String paramName) Iterates over all tags named according to tagName in a non-duplicated manner. |
void | FieldTagsHandler.forAllFieldTagTokens(String template, Properties attributes) Iterates over all tokens in current field tag with the name tagName and evaluates the body for every token. |
void | FieldTagsHandler.forAllFieldTags(String template, Properties attributes) Iterates over all tags of current field and evaluates the body of the tag for each field. |
void | FieldTagsHandler.forAllFields(String template, Properties attributes) Iterates over all fields of current class and evaluates the body of the tag for each field. |
void | AbstractProgramElementTagsHandler.forAllMemberTagTokens(String template, Properties attributes, int for_type) Describe what the method does
|
void | AbstractProgramElementTagsHandler.forAllMemberTags(String template, Properties attributes, int forType, String resourceKey, String[] arguments) Describe what the method does
|
void | AbstractProgramElementTagsHandler.forAllMembers(String template, Properties attributes, int forType) |
void | ParameterTagsHandler.forAllMethodParams(String template) Iterates over all parameters of current method and evaluates the body of the tag for each method. |
void | MethodTagsHandler.forAllMethodTagTokens(String template, Properties attributes) Iterates over all tokens in current method tag with the name tagName and evaluates the body for every token. |
void | MethodTagsHandler.forAllMethodTags(String template, Properties attributes) Iterates over all tags of current method and evaluates the body of the tag for each method. |
void | MethodTagsHandler.forAllMethods(String template, Properties attributes) Iterates over all methods of current class and evaluates the body of the tag for each method. |
void | PackageTagsHandler.forAllPackages(String template, Properties attributes) Iterates over all packages loaded by XJavadoc. |
void | ParameterTagsHandler.forAllParameterTypes(String template, Properties attributes) 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. |
void | PropertyTagsHandler.forAllPropertiesWithTag(String template, Properties attributes) Evaluates the body block for each property of current mbean.You may set whether superclasses are examined also
with the superclass attribute. |
String | Returns the full-qualified name of the current class. |
String | Returns the full-qualified name of the superclass of the current class. |
String | Returns the fully-qualified transformed name of the current class with package name. |
void | MergeTagsHandler.generateFileUsingTemplate(String dest_file, String templateFileName) A utility method used for generating the dest_file based on template_file template file. |
void | MergeTagsHandler.generateUsingMergedFile(String mergeFile, String contents) Processes the file specified in merge_file_pattern that has the text content contents. |
String | Returns the capitalized name of the current field. |
Object | ConfigTagsHandler.getConfigParameter(String paramName) Returns the value for the specified configuration parameter. |
String | FieldTagsHandler.getFieldTypeFor(XField field) Gets the FieldTypeFor attribute of the FieldTagsHandler class
|
String | TranslatorTagsHandler.getString(Properties attributes) Returns a localized text string. |
XExecutableMember | AbstractProgramElementTagsHandler.getXExecutableMemberForMemberName(String memberName, boolean superclasses, int forType) Searches for the XExecutableMember of the member with name methodName and returns it. |
XExecutableMember | AbstractProgramElementTagsHandler.getXExecutableMemberForMemberName(String memberName, int forType) Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object
|
String | Returns the getter method name for the current method by prefixing the method name with the proper getter prefix. |
String | Returns 'get' or 'is' getter prefix part of the current method. |
boolean | AbstractProgramElementTagsHandler.hasExecutableMember(XClass clazz, String executableMemberName, String[] parameters, boolean setCurrentExecutableMember, int forType) |
boolean | AbstractProgramElementTagsHandler.hasExecutableMember_OLD(XClass clazz, String executableMemberName, String[] parameters, boolean setCurrentExecutableMember, int forType) |
boolean | MethodTagsHandler.hasMethod(XClass clazz, String methodName, String[] parameters, boolean setCurrentMethod) Returns true if a method with the specified methodName+parameters is found in the class clazz. |
String | IdTagsHandler.id(Properties attributes) Generates an id attribute based on the given tag values. |
void | ClassTagsHandler.ifClassTagValueEquals(String template, Properties attributes) Evaluates the body if value for the class tag equals the specified value. |
void | ClassTagsHandler.ifClassTagValueMatches(String template, Properties attributes) Evaluate the body if the match variable equals with the value of the specified tag/parameter. |
void | ClassTagsHandler.ifClassTagValueNotEquals(String template, Properties attributes) Evaluates the body if value for the class tag not equals the specified value. |
void | ConfigTagsHandler.ifConfigParamEquals(String template, Properties attributes) Evaluate the body if the value of the configuration parameter equals value. |
boolean | ConfigTagsHandler.ifConfigParamEquals_Impl(Properties attributes) The implementation of ifConfigParamEquals and ifConfigParamEquals tags. |
void | ConfigTagsHandler.ifConfigParamGreaterOrEquals(String template, Properties attributes) Evaluate the body if the value of the configuration parameter is greater or equal to value. |
boolean | ConfigTagsHandler.ifConfigParamGreaterOrEquals_Impl(Properties attributes) The implementation of ifConfigParamGreaterOrEquals and ifConfigParamNotGreaterOrEquals tags. |
void | ConfigTagsHandler.ifConfigParamNotEquals(String template, Properties attributes) Evaluate the body if the value of the configuration parameter doesn't equal value. |
void | ConfigTagsHandler.ifConfigParamNotGreaterOrEquals(String template, Properties attributes) Evaluate the body if the value of the configuration parameter is not greater or equal to value. |
void | ConstructorTagsHandler.ifConstructorTagValueEquals(String template, Properties attributes) Evaluates the body if value for the constructor tag equals the specified value. |
void | ConstructorTagsHandler.ifConstructorTagValueNotEquals(String template, Properties attributes) Evaluates the body if value for the constructor tag not equals the specified value. |
void | ClassTagsHandler.ifDoesntHaveClassTag(String template, Properties attributes) Evaluates the body if current class doesn't have at least one tag with the specified name. |
void | ConstructorTagsHandler.ifDoesntHaveConstructor(String template, Properties attributes) Evaluate the body if current class doesn't have a constructor with the specified name+parameters. |
void | ConstructorTagsHandler.ifDoesntHaveConstructorTag(String template, Properties attributes) Evaluates the body if current constructor doesn't have at least one tag with the specified name. |
void | FieldTagsHandler.ifDoesntHaveFieldTag(String template, Properties attributes) Evaluates the body if current field doesnt have any tags with the specified name. |
void | MethodTagsHandler.ifDoesntHaveMethod(String template, Properties attributes) Evaluate the body if current class doesn't have a method with the specified name+parameters. |
void | MethodTagsHandler.ifDoesntHaveMethodTag(String template, Properties attributes) Evaluates the body if current method doesn't have at least one tag with the specified name. |
void | MethodTagsHandler.ifDoesntReturnVoid(String template, Properties attributes) Evaluates the body block if current method doesn't return void. |
void | MethodTagsHandler.ifDoesntThrowException(String template, Properties attributes) Evaluate the body block if current method doesn't throw the exceptions specified in the exceptions
attribute. |
void | FieldTagsHandler.ifFieldTagValueEquals(String template, Properties attributes) Evaluates the body if value for the field tag equals the specified value. |
void | ClassTagsHandler.ifHasClassTag(String template, Properties attributes) Evaluates the body if current class has at least one tag with the specified name. |
void | ConfigTagsHandler.ifHasConfigParam(String template, Properties attributes) Evaluates the body if config parameter specified is not null. |
void | ConstructorTagsHandler.ifHasConstructor(String template, Properties attributes) Evaluate the body if current class has a constructor with the specified name+parameters. |
void | ConstructorTagsHandler.ifHasConstructorTag(String template, Properties attributes) Evaluates the body if current constructor has at least one tag with the specified name. |
void | FieldTagsHandler.ifHasFieldTag(String template, Properties attributes) Evaluates the body if current field has at least one tag with the specified name. |
void | PropertyTagsHandler.ifHasGetMethodWithTag(String template, Properties attributes) 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. |
void | MethodTagsHandler.ifHasMethod(String template, Properties attributes) Evaluate the body if current class has a method with the specified name+parameters. |
void | MethodTagsHandler.ifHasMethodComment(String template) Evaluates the body block if current method has a javadoc comment. |
void | MethodTagsHandler.ifHasMethodTag(String template, Properties attributes) Evaluates the body if current method has at least one tag with the specified name. |
void | PropertyTagsHandler.ifHasParamWithTag(String template, Properties attributes) Determines if there is a get or set method with the required tag for the current property that also has the
requested parameter. |
void | ParameterTagsHandler.ifHasParams(String template, Properties attributes) Evaluates the body of the tag if current method/constructor has parameters. |
void | PropertyTagsHandler.ifHasSetMethodWithTag(String template, Properties attributes) 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. |
void | MethodTagsHandler.ifIsAbstract(String template, Properties attributes) Evaluate the body block if current method is abstract. |
void | ClassTagsHandler.ifIsClassAbstract(String template) Evaluate the body block if current class is abstract. |
void | ClassTagsHandler.ifIsClassNotAbstract(String template) Evaluate the body block if current class is not abstract. |
void | MethodTagsHandler.ifIsGetter(String template, Properties attributes) Evaluates the body if the specified method (or current method if none is supplied) is a getter method. |
void | MethodTagsHandler.ifIsNotAbstract(String template, Properties attributes) Evaluates the body block if current method is not abstract. |
void | MethodTagsHandler.ifIsNotOfType(String template, Properties attributes) Evaluates the body if the return type of the current method doesn't equal the specified value. |
void | TypeTagsHandler.ifIsNotOfType(String template, Properties attributes) Evaluate the body block if the entity is not of the specified type. |
void | TypeTagsHandler.ifIsNotPrimitive(String template, Properties attributes) Evaluate the body block if the value is not of a primitive type. |
void | TypeTagsHandler.ifIsNotPrimitiveArray(String template, Properties attributes) Evaluate the body block if the value is not of a primitive array type. |
void | TypeTagsHandler.ifIsNotPrimitiveOrString(String template, Properties attributes) Evaluate the body block if the value is of a primitive type or String. |
void | MethodTagsHandler.ifIsOfType(String template, Properties attributes) Evaluates the body if the return type of the current method equals the specified value. |
void | TypeTagsHandler.ifIsOfType(String template, Properties attributes) Evaluate the body block if the entity is of the specified type. |
boolean | MethodTagsHandler.ifIsOfTypeImpl(String template, Properties attributes) |
void | TypeTagsHandler.ifIsOfType_Impl(String template, Properties attributes, boolean condition) Implementation of ifIsOfType and ifIsNotOfType tags. |
void | TypeTagsHandler.ifIsPrimitive(String template, Properties attributes) Evaluate the body block if the value is of a primitive type. |
void | TypeTagsHandler.ifIsPrimitiveArray(String template, Properties attributes) Evaluate the body block if the value is of a primitive array type. |
void | TypeTagsHandler.ifIsPrimitiveOrString(String template, Properties attributes) Evaluate the body block if the value is of a primitive type or String. |
void | MethodTagsHandler.ifIsPublic(String template) Evaluates the body if the current method has public visibility. |
void | MethodTagsHandler.ifIsSetter(String template, Properties attributes) Evaluates the body if the specified method (or current method if none is supplied) is a setter method. |
void | MergeTagsHandler.ifMergeFileExists(String template, Properties attributes) Evaluates the body if the file exists specified by the "file" attribute. |
void | MethodTagsHandler.ifMethodNameEquals(String template, Properties attributes) Evaluates the body if method name equals to the specified value. |
void | MethodTagsHandler.ifMethodNameNotEquals(String template, Properties attributes) Evaluates the body if method name equals to the specified value. |
void | MethodTagsHandler.ifMethodTagValueEquals(String template, Properties attributes) Evaluates the body if value for the method tag equals the specified value. |
void | MethodTagsHandler.ifMethodTagValueNotEquals(String template, Properties attributes) Evaluates the body if value for the method tag not equals the specified value. |
void | MethodTagsHandler.ifReturnsVoid(String template, Properties attributes) Evaluate the body block if current method returns void. |
void | MethodTagsHandler.ifThrowsException(String template, Properties attributes) Evaluate the body block if current method throws the exceptions specified in the exceptions
attribute. |
String | ClassTagsHandler.importedList(Properties attributes) Iterates over all imported classes and packages imported in the current class and returns the list. |
String | Returns the value of match variable. |
String | AbstractProgramElementTagsHandler.memberComment(Properties attributes, int forType) |
void | MergeTagsHandler.merge(String template, Properties attributes) Merge contents of the file designated by the file parameter and evaluates the body if the file is not found. |
String | MethodTagsHandler.methodComment(Properties attributes) The comment for the current method. |
String | MethodTagsHandler.methodName(Properties attributes) Returns the name of the current method. |
String | Returns the name of the current method without the first three characters. |
String | The methodParamDescription method returns the comment text associated with the ParamTag for the
current Parameter
|
String | Returns the name of the current method parameter, current method parameter is set inside a forAllMethodParams tag
in each iteration. |
String | ParameterTagsHandler.methodParamType(Properties attributes) Returns the type of the current method parameter, current method parameter is set inside a forAllMethodParams tag
in each iteration. |
String | MethodTagsHandler.methodTagValue(Properties attributes) Iterates over all method tags with the specified tagName for the current method probably inside of a
forAllMethodTags body. |
String | MethodTagsHandler.methodType(Properties attributes) Returns the return type of the current method. |
String | The current class' modifiers. |
String | Describe what the method does
|
String | Describe what the method does
|
String | Any modifiers (static, volatile, etc.) for the current method. |
String | Returns the current package name. |
String | Returns the current package name as a path. |
void | PackageTagsHandler.packageOf(String template) Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag. |
String | PropertyTagsHandler.paramValueWithTag(Properties attributes) 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. |
String | ParameterTagsHandler.parameterList(Properties attributes) Iterates over all parameters in current method and returns a string containing definition of all those
parameters. |
String | IdTagsHandler.prefixedId(Properties attributes) Generates an id attribute based on the given prefix. |
String | Returns the property name extracted from the current method name. |
String | PropertyTagsHandler.propertyTypeWithTag(Properties attributes) The propertyTypeWithTag method figures out the type for the current property with tag by looking for
a getter, then a setter. |
String | Returns the DTD's public ID for an XML template. |
void | ClassTagsHandler.pushClass(String template, Properties attributes) Pushes the class specified by value parameter to top of stack making it the current class. |
String | Returns the schema for an XML template. |
void | ConstructorTagsHandler.setCurrentConstructor(String template, Properties attributes) Evaluate the body if current class has a constructor with the specified name+parameters. |
void | MethodTagsHandler.setCurrentMethod(String template, Properties attributes) Evaluate the body if current class has a method with the specified name+parameters. |
void | AbstractProgramElementTagsHandler.setMatchValue(String template, Properties attributes) Sets the value of match variable. |
String | 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. |
String | AbstractProgramElementTagsHandler.skipToken(Properties attributes) Skips current token. |
String | Returns the symbolic name of the current class. |
String | Returns the DTD's system ID for an XML template. |
String | TagDefTagsHandler.tagDef(Properties attributes) Defines a template tag handler for a template tag to TemplateEngine. |
String | Returns the transformed name of the current class with package name. |
String | MethodTagsHandler.transformedMethodType(Properties attributes) Returns the transformed return type of the current method. |
String | TypeTagsHandler.typeWithoutDimensions(Properties attributes) Returns the type specified with the type parameter without dimensions. |
Methods which throw type xdoclet.XDocletException | |
void | XmlValidator.validate(File xmlFile) Validates an XML file for conformance to a declared DTD or XMLSchema. |
Methods which throw type xdoclet.XDocletException | |
void | Describe what the method does
|
void | Describe what the method does
|
void | Called to start execution of the sub-task. |
void | Describe what the method does
|
void | XDocletTagSupport.generate(String template) |
void | TemplateSubTask.generateForClass(XClass clazz) Processed template for clazz and generates output file for clazz. |
String | XDocletTagSupport.getExpandedDelimitedTagValue(Properties attributes, int forType) The getExpandedDelimitedTagValue method returns a delimited version with class names expanded if
requested of the tag value. |
String | TemplateSubTask.getGeneratedFileName(XClass clazz) Returns class name for the generated file. |
String | XDocletTagSupport.getTagValue(Properties attributes, int forType) Return the Value of a tag specified in a Properties object. |
String | XDocletTagSupport.getTagValue(int forType, String tagName, String paramName, String validValues, String defaultValue, boolean superclasses, boolean mandatory) Gets the TagValue attribute of the XDocletTagSupport class
|
String | XDocletTagSupport.getTagValue(int forType, XDoc doc, String tagName, String paramName, String validValues, String defaultValue, boolean superclasses, boolean mandatory) |
boolean | XDocletTagSupport.hasTag(Properties attributes, int forType) A utility method used by ifHasClassTag/ifDoesntHaveClassTag and ifHasMethodTag/ifDoesntHaveMethodTag, return true
if at least one tag exists with the specified name. |
void | Initializes SubTask. |
void | TemplateSubTask.init(XJavaDoc xJavaDoc) Describe what the method does
|
boolean | GenerationManager.isGenerationNeeded(File file) 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. |
boolean | GenerationManager.isGenerationNeeded(XClass clazz, File file, boolean withTemplate) Test if a Java source mmust be generated or not depending of timestamp of elements involved. |
boolean | XDocletTagSupport.isTagValueEqual(Properties attributes, int forType) A utility method used by ifMethodTagValueEquals/ifMethodTagValueNotEquals and
ifClassTagValueEquals/ifClassTagValueNotEquals, return true if the value of the tag/XParameter equals with value. |
void | XDocletTagSupport.mandatoryParamNotFound(XDoc doc, String paramName, String tagName) Throws an XDocletException exception to stop the build process. |
void | XDocletTagSupport.mandatoryTemplateTagParamNotFound(String templateTagName, String paramName) Throws an XDocletException exception to stop the build process. |
boolean | TemplateSubTask.matchesGenerationRules(XClass clazz) Returns true if output not already generated for clazz, and is of the specified type and has the specified class
tag; false otherwise. |
String | XDocletTagSupport.modifiers(int forType) Return the modifiers (static, private, etc.) for the current program element of the specified type. |
void | TemplateSubTask.setTemplateFile(File templateFile) Sets the name of the template file to use for generation
|
void | XDocletMain.start(XJavaDoc xJavaDoc) Starts XDoclet
|
void | Describe what the method does
|
void | Describe what the method does
|
void | |
void | |
void | Called to validate configuration parameters. |
void | Called to validate configuration parameters. |
Methods which throw type xdoclet.XDocletException | |
String | AntPropertyTagsHandler.property(Properties attributes) Returns the values of a configuration parameter with the name paramName. |
http://xdoclet.sourceforge.net/ |