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