checkForWrap
protected String checkForWrap(String pText)
A utility method used by firstSentenceDescription to replace end of line by space.
pText
- Description of Parameter
- Description of the Returned Value
currentToken
public String currentToken(Properties attributes)
throws XDocletException
Returns current token inside forAllClassTagTokens.
attributes
- The attributes of the template tag
- value of currently processed token
exceptionList
protected String exceptionList(Properties attributes,
int forType)
throws XDocletException
Describe what the method does
attributes
- Describe what the parameter doesforType
- Describe what the parameter does
- Describe the return value
firstSentenceDescriptionOfCurrentMember
protected String firstSentenceDescriptionOfCurrentMember(XMember member)
throws XDocletException
Describe what the method does
member
- Describe what the parameter does
- Describe the return value
forAllMemberTagTokens
protected void forAllMemberTagTokens(String template,
Properties attributes,
int for_type)
throws XDocletException
Describe what the method does
template
- Describe what the parameter doesattributes
- Describe what the parameter doesfor_type
- Describe what the parameter does
forAllMemberTags
protected void forAllMemberTags(String template,
Properties attributes,
int forType,
String resourceKey,
String[] arguments)
throws XDocletException
Describe what the method does
template
- Describe what the parameter doesattributes
- Describe what the parameter doesforType
- Describe what the parameter doesresourceKey
- Describe what the parameter doesarguments
- Describe what the parameter does
forAllMembers
protected void forAllMembers(String template,
Properties attributes,
int forType)
throws XDocletException
template
- Describe what the parameter doesattributes
- Describe what the parameter doesforType
- Describe what the parameter does
- the already Set contains XMember objects. equals/hashCode should be defined in
XMember and be implemented in all of the implementing classes.
getAllClasses
public static Collection getAllClasses()
Utility method to get classes for iteration used by various methods. The result depends on the context: are we
within a forAllPackages iteration or not.
- An array with all classes in that context in it.
getClassNameFor
public static String getClassNameFor(XClass clazz)
Returns the not-full-qualified name of the specified class without the package name.
getFullClassNameFor
public static String getFullClassNameFor(XClass clazz)
Returns the full-qualified name of the current class with the package name.
- fully qualified classname
getFullSuperclassNameFor
public static String getFullSuperclassNameFor(XClass clazz)
Returns the full-qualified name of the superclass of the specified class.
- superclass' fully qualified classname
getIndentChars
protected char[] getIndentChars(Properties attributes)
A utility method to get the blank space characters used for indenting comments.
attributes
- The attributes of the template tag
MethodTagsHandler.methodComment(java.util.Properties)
, ClassTagsHandler.classComment(java.util.Properties)
getXExecutableMemberForMemberName
protected XExecutableMember getXExecutableMemberForMemberName(String memberName,
boolean superclasses,
int forType)
throws XDocletException
Searches for the XExecutableMember of the member with name methodName and returns it.
memberName
- superclasses
- Search superclasses.forType
-
- The XMethod for the method named value
getXExecutableMemberForMemberName
protected XExecutableMember getXExecutableMemberForMemberName(String memberName,
int forType)
throws XDocletException
Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object
memberName
- Describe what the parameter doesforType
- Describe what the parameter does
- The XExecutableMemberForMemberName value
hasExecutableMember
protected static boolean hasExecutableMember(XClass clazz,
String executableMemberName,
String[] parameters,
boolean setCurrentExecutableMember,
int forType)
throws XDocletException
hasExecutableMember_OLD
protected static boolean hasExecutableMember_OLD(XClass clazz,
String executableMemberName,
String[] parameters,
boolean setCurrentExecutableMember,
int forType)
throws XDocletException
clazz
- executableMemberName
- parameters
- setCurrentExecutableMember
- forType
-
- Remove. For archeologists only
makeCopyOfArray
protected static Object[] makeCopyOfArray(Object[] objects)
Used to protect returned arrays from being modified (sorted, reordered for example).
objects
- array of objects
matchValue
public String matchValue()
throws XDocletException
Returns the value of match variable. Match variable serves as a variable for templates, you set it somewhere in
template and look it up somewhere else in template.
- Description of the Returned Value
memberComment
protected String memberComment(Properties attributes,
int forType)
throws XDocletException
attributes
- Describe what the parameter doesforType
- Describe what the parameter does
- Describe the return value
- There is similar functionality in xjavadoc.XDoc. Use that instead (needs a little
rework to be more flexible).
setMatchValue
public void setMatchValue(String template,
Properties attributes)
throws XDocletException
Sets the value of match variable.
template
- The body of the block tagattributes
- The attributes of the template tag
- name = "value"
optional = "false"
description = "The new value for matchPattern."
skipToken
public String skipToken(Properties attributes)
throws XDocletException
Skips current token. Returns empty string.
attributes
- The attributes of the template tag