xdoclet.tagshandler
public abstract class AbstractProgramElementTagsHandler extends XDocletTagSupport
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
currentToken
The current token.
|
protected static java.lang.String |
matchPattern
Template can use matchPattern as a place where they can put volatile variable.
|
protected static java.util.StringTokenizer |
tagTokenizer
The StringTokenizer object doing the tokenization.
|
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
AbstractProgramElementTagsHandler() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
checkForWrap(java.lang.String pText)
A utility method used by firstSentenceDescription to replace end of line by space.
|
java.lang.String |
currentToken(java.util.Properties attributes)
Returns current token inside forAllClassTagTokens.
|
protected java.lang.String |
exceptionList(java.util.Properties attributes,
int forType)
Return the throws clause of the specified constructor or method declaration.
|
protected java.lang.String |
firstSentenceDescriptionOfCurrentMember(xjavadoc.XMember member)
Describe what the method does
|
protected void |
forAllMembers(java.lang.String template,
java.util.Properties attributes,
int forType) |
protected void |
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 void |
forAllMemberTagTokens(java.lang.String template,
java.util.Properties attributes,
int for_type)
Describe what the method does
|
static java.util.Collection |
getAllClasses()
Utility method to get classes for iteration used by various methods.
|
static java.lang.String |
getClassNameFor(xjavadoc.XClass clazz)
Returns the not-full-qualified name of the specified class without the package name.
|
static java.lang.String |
getFullClassNameFor(xjavadoc.XClass clazz)
Returns the full-qualified name of the current class with the package name.
|
static java.lang.String |
getFullSuperclassNameFor(xjavadoc.XClass clazz)
Returns the full-qualified name of the superclass of the specified class.
|
protected char[] |
getIndentChars(java.util.Properties attributes)
A utility method to get the blank space characters used for indenting comments.
|
protected xjavadoc.XExecutableMember |
getXExecutableMemberForMemberName(java.lang.String memberName,
boolean superclasses,
int forType)
Searches for the XExecutableMember of the member with name methodName and returns it.
|
protected xjavadoc.XExecutableMember |
getXExecutableMemberForMemberName(java.lang.String memberName,
int forType)
Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object
|
protected static boolean |
hasExecutableMember_OLD(xjavadoc.XClass clazz,
java.lang.String executableMemberName,
java.lang.String[] parameters,
boolean setCurrentExecutableMember,
int forType) |
protected static boolean |
hasExecutableMember(xjavadoc.XClass clazz,
java.lang.String executableMemberName,
java.lang.String[] parameters,
boolean setCurrentExecutableMember,
int forType) |
protected static java.lang.Object[] |
makeCopyOfArray(java.lang.Object[] objects)
Used to protect returned arrays from being modified (sorted, reordered for example).
|
java.lang.String |
matchValue()
Returns the value of match variable.
|
protected java.lang.String |
memberComment(java.util.Properties attributes,
int forType)
The comment for the current class member of the specified type (field, constructor or method).
|
void |
setMatchValue(java.lang.String template,
java.util.Properties attributes)
Sets the value of match variable.
|
java.lang.String |
skipToken(java.util.Properties attributes)
Skips current token.
|
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 java.lang.String currentToken
protected static java.util.StringTokenizer tagTokenizer
protected static java.lang.String matchPattern
public static java.lang.String getClassNameFor(xjavadoc.XClass clazz)
clazz
- classpublic static java.lang.String getFullClassNameFor(xjavadoc.XClass clazz)
clazz
- classpublic static java.lang.String getFullSuperclassNameFor(xjavadoc.XClass clazz)
clazz
- classpublic static java.util.Collection getAllClasses()
protected static boolean hasExecutableMember_OLD(xjavadoc.XClass clazz, java.lang.String executableMemberName, java.lang.String[] parameters, boolean setCurrentExecutableMember, int forType) throws XDocletException
clazz
- executableMemberName
- parameters
- setCurrentExecutableMember
- forType
- XDocletException
protected static java.lang.Object[] makeCopyOfArray(java.lang.Object[] objects)
objects
- array of objectsprotected static boolean hasExecutableMember(xjavadoc.XClass clazz, java.lang.String executableMemberName, java.lang.String[] parameters, boolean setCurrentExecutableMember, int forType) throws XDocletException
XDocletException
public void setMatchValue(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 matchValue() throws XDocletException
XDocletException
- Description of Exceptionpublic java.lang.String currentToken(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic java.lang.String skipToken(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exceptionprotected xjavadoc.XExecutableMember getXExecutableMemberForMemberName(java.lang.String memberName, int forType) throws XDocletException
memberName
- Describe what the parameter doesforType
- Describe what the parameter doesXDocletException
- Describe the exceptionprotected xjavadoc.XExecutableMember getXExecutableMemberForMemberName(java.lang.String memberName, boolean superclasses, int forType) throws XDocletException
memberName
- superclasses
- Search superclasses.forType
- XDocletException
protected char[] getIndentChars(java.util.Properties attributes)
indent
tag attribute. Defaults to zero spaces if no indent
attribute is present.attributes
- The attributes of the template tagindent
space charactersmemberComment(java.util.Properties, int)
,
ClassTagsHandler.classComment(java.util.Properties)
,
ClassTagsHandler.classCommentText(java.util.Properties)
,
ClassTagsHandler.classCommentTags(java.util.Properties)
protected java.lang.String exceptionList(java.util.Properties attributes, int forType) throws XDocletException
attributes
- The attributes of the template tagforType
- Constant indicating constructor or methodXDocletException
- Describe the exceptionMethodTagsHandler.exceptionList(java.util.Properties)
,
ConstructorTagsHandler.exceptionList(java.util.Properties)
protected void forAllMemberTagTokens(java.lang.String template, java.util.Properties attributes, int for_type) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagfor_type
- Describe what the parameter doesXDocletException
- Describe the exceptionprotected void forAllMemberTags(java.lang.String template, java.util.Properties attributes, int forType, java.lang.String resourceKey, java.lang.String[] arguments) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagforType
- Describe what the parameter doesresourceKey
- Describe what the parameter doesarguments
- Describe what the parameter doesXDocletException
- Describe the exceptionprotected java.lang.String memberComment(java.util.Properties attributes, int forType) throws XDocletException
attributes
- The attributes of the template tagforType
- Member typeXDocletException
- Describe the exceptionMethodTagsHandler.methodComment(java.util.Properties)
,
FieldTagsHandler.fieldComment(java.util.Properties)
,
ConstructorTagsHandler.constructorComment(java.util.Properties)
protected java.lang.String firstSentenceDescriptionOfCurrentMember(xjavadoc.XMember member) throws XDocletException
member
- Describe what the parameter doesXDocletException
- Describe the exceptionprotected void forAllMembers(java.lang.String template, java.util.Properties attributes, int forType) throws XDocletException
template
- Describe what the parameter doesattributes
- Describe what the parameter doesforType
- Describe what the parameter doesXDocletException
- Describe the exceptionprotected java.lang.String checkForWrap(java.lang.String pText)
pText
- Description of Parameter