xdoclet.tagshandler
public abstract class AbstractProgramElementTagsHandler extends XDocletTagSupport
Version: $Revision: 1.17 $
UNKNOWN: Oct 15, 2001
Field Summary | |
---|---|
protected static String | currentToken
The current token. |
protected static String | matchPattern
Template can use matchPattern as a place where they can put volatile variable. |
protected static StringTokenizer | tagTokenizer
The StringTokenizer object doing the tokenization. |
Method Summary | |
---|---|
protected String | checkForWrap(String pText)
A utility method used by firstSentenceDescription to replace end of line by space.
|
String | currentToken(Properties attributes)
Returns current token inside forAllClassTagTokens.
|
protected String | exceptionList(Properties attributes, int forType)
Return the throws clause of the specified constructor or method declaration. |
protected String | firstSentenceDescriptionOfCurrentMember(XMember member)
Describe what the method does
|
protected void | forAllMembers(String template, Properties attributes, int forType) |
protected void | forAllMemberTags(String template, Properties attributes, int forType, String resourceKey, String[] arguments)
Describe what the method does
|
protected void | forAllMemberTagTokens(String template, Properties attributes, int for_type)
Describe what the method does
|
static Collection | getAllClasses()
Utility method to get classes for iteration used by various methods. |
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 current class with the package name.
|
static String | getFullSuperclassNameFor(XClass clazz)
Returns the full-qualified name of the superclass of the specified class.
|
protected char[] | getIndentChars(Properties attributes)
A utility method to get the blank space characters used for indenting comments. |
protected XExecutableMember | getXExecutableMemberForMemberName(String memberName, int forType)
Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object
|
protected XExecutableMember | getXExecutableMemberForMemberName(String memberName, boolean superclasses, int forType)
Searches for the XExecutableMember of the member with name methodName and returns it.
|
protected static boolean | hasExecutableMember(XClass clazz, String executableMemberName, String[] parameters, boolean setCurrentExecutableMember, int forType) |
protected static boolean | hasExecutableMember_OLD(XClass clazz, String executableMemberName, String[] parameters, boolean setCurrentExecutableMember, int forType) |
protected static Object[] | makeCopyOfArray(Object[] objects)
Used to protect returned arrays from being modified (sorted, reordered for example).
|
String | matchValue()
Returns the value of match variable. |
protected String | memberComment(Properties attributes, int forType)
The comment for the current class member of the specified type (field, constructor or method).
|
void | setMatchValue(String template, Properties attributes)
Sets the value of match variable.
|
String | skipToken(Properties attributes)
Skips current token. |
Parameters: pText Description of Parameter
Returns: Description of the Returned Value
Parameters: attributes The attributes of the template tag
Returns: value of currently processed token
Throws: XDocletException Description of Exception
UNKNOWN: type = "content"
Parameters: attributes The attributes of the template tag forType Constant indicating constructor or method
Returns: throws clause
Throws: XDocletException Describe the exception
See Also: MethodTagsHandler exceptionList
Parameters: member Describe what the parameter does
Returns: Describe the return value
Throws: XDocletException Describe the exception
Parameters: template Describe what the parameter does attributes Describe what the parameter does forType Describe what the parameter does
Throws: XDocletException Describe the exception
UNKNOWN: the already Set contains XMember objects. equals/hashCode should be defined in XMember and be implemented in all of the implementing classes.
Parameters: template The body of the block tag attributes The attributes of the template tag forType Describe what the parameter does resourceKey Describe what the parameter does arguments Describe what the parameter does
Throws: XDocletException Describe the exception
Parameters: template The body of the block tag attributes The attributes of the template tag for_type Describe what the parameter does
Throws: XDocletException Describe the exception
Returns: An array with all classes in that context in it.
Parameters: clazz class
Returns: classname
Parameters: clazz class
Returns: fully qualified classname
Parameters: clazz class
Returns: superclass' fully qualified classname
indent
tag attribute. Defaults to zero spaces if no indent
attribute is present.
Parameters: attributes The attributes of the template tag
Returns: Array of indent
space characters
See Also: AbstractProgramElementTagsHandler classComment classCommentText classCommentTags
Parameters: memberName Describe what the parameter does forType Describe what the parameter does
Returns: The XExecutableMemberForMemberName value
Throws: XDocletException Describe the exception
Parameters: memberName superclasses Search superclasses. forType
Returns: The XMethod for the method named value
Throws: XDocletException
Parameters: clazz executableMemberName parameters setCurrentExecutableMember forType
Returns:
Throws: XDocletException
UNKNOWN: Remove. For archeologists only
Parameters: objects array of objects
Returns: copy of array
Returns: Description of the Returned Value
Throws: XDocletException Description of Exception
UNKNOWN: type = "content"
Parameters: attributes The attributes of the template tag forType Member type
Returns: javadoc comment
Throws: XDocletException Describe the exception
See Also: MethodTagsHandler fieldComment constructorComment
UNKNOWN: There is similar functionality in xjavadoc.XDoc. Use that instead (needs a little rework to be more flexible).
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" description = "The new value for matchPattern."
Parameters: attributes The attributes of the template tag
Returns: Empty string
Throws: XDocletException Description of Exception
UNKNOWN: type = "content"