xdoclet.tagshandler
public class ClassTagsHandler extends AbstractProgramElementTagsHandler
Modifier and Type | Field and Description |
---|---|
protected static java.text.DateFormat |
dateFormatter
Used for setting the timestamp for xdoclet-generated marker in generated files.
|
protected static java.util.Calendar |
now |
currentToken, matchPattern, tagTokenizer
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
ClassTagsHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
classComment(java.util.Properties attributes)
The comment for the current class.
|
java.lang.String |
classCommentTags(java.util.Properties attributes)
The javadoc comment tags for the current class (plus xdoclet-generated).
|
java.lang.String |
classCommentText(java.util.Properties attributes)
The text of the javadoc comment for the current class.
|
java.lang.String |
className()
Returns the not-fully-qualified name of the current class without the package name.
|
void |
classOf(java.lang.String template)
Returns the not-full-qualified name of the full-qualified class name specified in the body of this tag.
|
java.lang.String |
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 |
classTagValueMatch(java.util.Properties attributes)
Sets the value of match variable.
|
java.lang.String |
firstSentenceDescription(java.util.Properties attributes)
Return first sentence of standard javadoc of current class.
|
void |
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.
|
void |
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 |
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.
|
void |
forAllDistinctClassTags(java.lang.String template,
java.util.Properties attributes)
Iterates over all tags named according to tagName in a non-duplicated manner.
|
static void |
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.
|
java.lang.String |
fullClassName()
Returns the full-qualified name of the current class.
|
java.lang.String |
fullSuperclassName()
Returns the full-qualified name of the superclass of the current class.
|
java.lang.String |
fullTransformedClassName()
Returns the fully-qualified transformed name of the current class with package name.
|
static java.lang.String |
getClassNameFor(xjavadoc.XClass clazz)
Deprecated.
use XClass.name()
|
static java.lang.String |
getFullClassNameFor(xjavadoc.XClass clazz)
Deprecated.
use XClass.qualifiedName()
|
void |
ifClassTagValueEquals(java.lang.String template,
java.util.Properties attributes)
Evaluates the body if value for the class tag equals the specified value.
|
void |
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 |
ifClassTagValueNotEquals(java.lang.String template,
java.util.Properties attributes)
Evaluates the body if value for the class tag not equals the specified value.
|
void |
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 |
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 |
ifIsClassAbstract(java.lang.String template)
Evaluate the body block if current class is abstract.
|
void |
ifIsClassNotAbstract(java.lang.String template)
Evaluate the body block if current class is not abstract.
|
java.lang.String |
importedList(java.util.Properties attributes)
Deprecated.
Make sure the template file uses full qualified class names everywhere instead.
|
java.lang.String |
modifiers()
The current class' modifiers.
|
void |
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.
|
java.lang.String |
symbolicClassName()
Returns the symbolic name of the current class.
|
java.lang.String |
transformedClassName()
Returns the transformed name of the current class with package name.
|
checkForWrap, currentToken, exceptionList, firstSentenceDescriptionOfCurrentMember, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getFullSuperclassNameFor, getIndentChars, getXExecutableMemberForMemberName, getXExecutableMemberForMemberName, hasExecutableMember_OLD, hasExecutableMember, makeCopyOfArray, matchValue, memberComment, setMatchValue, skipToken
delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
getXJavaDoc, setXJavaDoc
protected static final java.text.DateFormat dateFormatter
protected static final java.util.Calendar now
public static java.lang.String getClassNameFor(xjavadoc.XClass clazz)
clazz
- Description of Parameterpublic static java.lang.String getFullClassNameFor(xjavadoc.XClass clazz)
clazz
- Description of Parameterpublic static void forAllDistinctClassTags(TemplateEngine engine, java.lang.String template, java.lang.String tagName, java.lang.String paramName) throws XDocletException
engine
- template
- The body of the block tagtagName
- The tag to iterateparamName
- The tag parameter that should be used as identifier.XDocletException
- if something goes wrongpublic void forAllDistinctClassTags(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- if something goes wrongpublic java.lang.String className() throws XDocletException
XDocletException
- if something goes wrongpublic java.lang.String fullClassName() throws XDocletException
XDocletException
- if something goes wrongpublic java.lang.String transformedClassName() throws XDocletException
XDocletException
- if something goes wrongpublic java.lang.String fullTransformedClassName() throws XDocletException
XDocletException
- if something goes wrongpublic java.lang.String fullSuperclassName() throws XDocletException
XDocletException
- if something goes wrongpublic void classOf(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
- if something goes wrongpublic void ifIsClassAbstract(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
- Description of ExceptionifIsClassNotAbstract(java.lang.String)
public void ifIsClassNotAbstract(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
- Description of ExceptionifIsClassAbstract(java.lang.String)
public void pushClass(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void forAllClasses(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic java.lang.String modifiers() throws XDocletException
XDocletException
- Describe the exceptionpublic java.lang.String symbolicClassName() throws XDocletException
XDocletException
- Description of Exceptionpublic void ifDoesntHaveClassTag(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void ifHasClassTag(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void ifClassTagValueMatches(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void ifClassTagValueEquals(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void ifClassTagValueNotEquals(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic java.lang.String classTagValue(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic java.lang.String classTagValueMatch(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void forAllClassTags(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void forAllClassTagTokens(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic java.lang.String classComment(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of ExceptionMethodTagsHandler.methodComment(java.util.Properties)
,
classCommentText(java.util.Properties)
,
classCommentTags(java.util.Properties)
public java.lang.String classCommentText(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of ExceptionMethodTagsHandler.methodComment(java.util.Properties)
,
classComment(java.util.Properties)
public java.lang.String classCommentTags(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of ExceptionMethodTagsHandler.methodComment(java.util.Properties)
,
classComment(java.util.Properties)
public java.lang.String firstSentenceDescription(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic java.lang.String importedList(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exception