xdoclet.tagshandler
public class ClassTagsHandler extends AbstractProgramElementTagsHandler
Version: $Revision: 1.25 $
UNKNOWN: Oct 14, 2001 namespace = "Class"
Field Summary | |
---|---|
protected static DateFormat | dateFormatter
Used for setting the timestamp for xdoclet-generated marker in generated files. |
protected static Calendar | now |
Method Summary | |
---|---|
String | classComment(Properties attributes)
The comment for the current class.
|
String | classCommentTags(Properties attributes)
The javadoc comment tags for the current class (plus xdoclet-generated).
|
String | classCommentText(Properties attributes)
The text of the javadoc comment for the current class.
|
String | className()
Returns the not-fully-qualified name of the current class without the package name.
|
void | classOf(String template)
Returns the not-full-qualified name of the full-qualified class name specified in the body of this tag.
|
String | classTagValue(Properties attributes)
Iterates over all class tags with the specified tagName and evaluates the body of the tag for each class tag.
|
String | classTagValueMatch(Properties attributes)
Sets the value of match variable. |
String | firstSentenceDescription(Properties attributes)
Return first sentence of standard javadoc of current class.
|
void | forAllClasses(String template, Properties attributes)
Iterates over all classes loaded by xjavadoc and evaluates the body of the tag for each class. |
void | 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 | forAllClassTagTokens(String template, Properties attributes)
Iterates over all tokens in specified class tag with the name tagName and evaluates the body for every token.
|
static void | forAllDistinctClassTags(TemplateEngine engine, String template, String tagName, String paramName)
Iterates over all tags named according to tagName in a non-duplicated manner. |
void | forAllDistinctClassTags(String template, Properties attributes)
Iterates over all tags named according to tagName in a non-duplicated manner. |
String | fullClassName()
Returns the full-qualified name of the current class.
|
String | fullSuperclassName()
Returns the full-qualified name of the superclass of the current class.
|
String | fullTransformedClassName()
Returns the fully-qualified transformed name of the current class with package name.
|
static String | getClassNameFor(XClass clazz)
Returns the not-full-qualified name of the specified class without the package name.
|
static String | getFullClassNameFor(XClass clazz)
Returns the full-qualified name of the specified class with the package name.
|
void | ifClassTagValueEquals(String template, Properties attributes)
Evaluates the body if value for the class tag equals the specified value.
|
void | ifClassTagValueMatches(String template, Properties attributes)
Evaluate the body if the match variable equals with the value of the specified tag/parameter.
|
void | ifClassTagValueNotEquals(String template, Properties attributes)
Evaluates the body if value for the class tag not equals the specified value.
|
void | ifDoesntHaveClassTag(String template, Properties attributes)
Evaluates the body if current class doesn't have at least one tag with the specified name.
|
void | ifHasClassTag(String template, Properties attributes)
Evaluates the body if current class has at least one tag with the specified name.
|
void | ifIsClassAbstract(String template)
Evaluate the body block if current class is abstract.
|
void | ifIsClassNotAbstract(String template)
Evaluate the body block if current class is not abstract.
|
String | importedList(Properties attributes)
Iterates over all imported classes and packages imported in the current class and returns the list. |
String | modifiers()
The current class' modifiers.
|
void | pushClass(String template, Properties attributes)
Pushes the class specified by value parameter to top of stack making it the current class.
|
String | symbolicClassName()
Returns the symbolic name of the current class. |
String | transformedClassName()
Returns the transformed name of the current class with package name.
|
Parameters: attributes The attributes of the template tag
Returns: javadoc comment
Throws: XDocletException Description of Exception
See Also: MethodTagsHandler classCommentText classCommentTags
UNKNOWN: type = "content" name = "no-comment-signs" optional = "true" values = "true,false" description = "If true * then don't decorate the comment with comment signs. Default is false." name = "indent" optional = "true" description = "Number of spaces to indent the comment. * Default is 0."
Parameters: attributes The attributes of the template tag
Returns: The class-level tags
Throws: XDocletException Description of Exception
See Also: MethodTagsHandler classComment
UNKNOWN: type = "content" name = "indent" optional = "true" description = "Number of spaces to indent the tags. * Default is 0."
Parameters: attributes The attributes of the template tag
Returns: comment text
Throws: XDocletException Description of Exception
See Also: MethodTagsHandler classComment
UNKNOWN: type = "content" name = "no-comment-signs" optional = "true" values = "true,false" description = "If true * then don't decorate the comment with comment signs. Default is false." name = "indent" optional = "true" description = "Number of spaces to indent the comment. * Default is 0." handle inline link tags in comment text
Returns: the name of the current class
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content"
Parameters: template The body of the block tag
Throws: XDocletException if something goes wrong
UNKNOWN: type = "block"
Parameters: attributes The attributes of the template tag
Returns: Description of the Returned Value
Throws: XDocletException Description of Exception
UNKNOWN: type = "content" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters." name = "values" description = "The valid values for the parameter, comma separated. An * error message is printed if the parameter value is not one of the values." name = "default" description = "The default value is returned if parameter not specified * by user for the tag." name = "superclasses" values = "true,false" description = "If true then traverse * superclasses also, otherwise look up the tag in current concrete class only." name = "mandatory" values = "true,false" description = "Generate an error if parameter not * specified by user for the tag."
Parameters: attributes The attributes of the template tag
Returns: Description of the Returned Value
Throws: XDocletException Description of Exception
UNKNOWN: type = "content" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters."
Parameters: attributes The attributes of the template tag
Returns: class comment's first sentence
Throws: XDocletException Description of Exception
UNKNOWN: type = "content" name = "no-description-if-lacking" optional = "true" description = "Returns 'No * Description' if comment is lacking."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "abstract" optional = "true" values = "true,false" description = "If true then accept * abstract classes also; otherwise don't." name = "type" optional = "true" description = "For all classes by the type." name = "extent" optional = "true" values = "concrete-type,superclass,hierarchy" description = "Specifies the extent of the type search. If concrete-type then only check the concrete type, if * superclass then check also superclass, if hierarchy then search the whole hierarchy and find if the class is * of the specified type. Default is hierarchy."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "superclasses" values = "true,false" description = "If true then traverse * superclasses also, otherwise look up the tag in current concrete class only." name = "tagKey" description = "A tag property that will be used as a unique key. This is * used to avoid duplicate code due to similar tags in superclasses."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The name of the tag to look in." name = "paramName" optional = "false" description = "The parameter of the tag whose value * is to be tokenized." name = "superclasses" values = "true,false" description = "If true then traverse * superclasses also, otherwise look up the tag in current concrete class only." name = "delimiter" description = "delimiter for the StringTokenizer. consult javadoc for * java.util.StringTokenizer default is ','" name = "skip" description = "how many tokens to skip on start"
Parameters: engine template The body of the block tag tagName The tag to iterate paramName The tag parameter that should be used as identifier.
Throws: XDocletException if something goes wrong
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException if something goes wrong
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag to iterate." name = "tagKey" optional = "false" description = "The tag parameter that should be used as * identifier."
Returns: the name of the current class
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content"
Returns: the name of the superclass of the current class
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content"
Returns: the name of the current class
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content"
Deprecated: use XClass.name()
Returns the not-full-qualified name of the specified class without the package name.Parameters: clazz Description of Parameter
Returns: Description of the Returned Value
UNKNOWN: duplicate in AbstractProgramElementTagsHandler
Deprecated: use XClass.qualifiedName()
Returns the full-qualified name of the specified class with the package name.Parameters: clazz Description of Parameter
Returns: Description of the Returned Value
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters." name = "value" optional = "false" description = "The desired value."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: (Aslak) It appears that this method does the same job as ifClassTagValueEquals. It also appears that no templates are using it. Candidate for removal? type = "block" name = "values" description = "The valid values for the parameter, comma separated. An * error message is printed if the parameter value is not one of the values." name = "default" description = "The default value is returned if parameter not specified * by user for the tag." name = "superclasses" values = "true,false" description = "If true then traverse * superclasses also, otherwise look up the tag in current concrete class only."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters." name = "value" optional = "false" description = "The desired value."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters." name = "superclasses" values = "true,false" description = "If true then traverse * superclasses also, otherwise look up the tag in current concrete class only." name = "error" description = "Show this error message if no tag found."
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters." name = "superclasses" values = "true,false" description = "If true then traverse * superclasses also, otherwise look up the tag in current concrete class only." name = "error" description = "Show this error message if no tag found."
Parameters: template The body of the block tag
Throws: XDocletException Description of Exception
See Also: ClassTagsHandler
UNKNOWN: type = "block"
Parameters: template The body of the block tag
Throws: XDocletException Description of Exception
See Also: ClassTagsHandler
UNKNOWN: type = "block"
Deprecated: Make sure the template file uses full qualified class names everywhere instead.
Iterates over all imported classes and packages imported in the current class and returns the list. The composed string has 'import ' in front of each import statement, and each import is in a separate line.Parameters: attributes The attributes of the template tag
Returns: import statements
Throws: XDocletException Description of Exception
UNKNOWN: type = "content" name = "currentClass" optional = "false" description = "???"
Returns: modifiers
Throws: XDocletException Describe the exception
UNKNOWN: type = "content"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "value" optional = "false" values = "return-type,whatever class name" description = "If return-type specified then push current method return type, else find the XClass for the * class name and push it."
Returns: The symbolic name of the current class
Throws: XDocletException Description of Exception
UNKNOWN: type = "content"
Returns: the name of the current class
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content"