|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.tagshandler.AbstractProgramElementTagsHandler
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. |
Fields inherited from class xdoclet.XDocletTagSupport |
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER |
Constructor Summary | |
AbstractProgramElementTagsHandler()
|
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)
Describe what the method does |
protected String |
firstSentenceDescriptionOfCurrentMember(xjavadoc.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(xjavadoc.XClass clazz)
Returns the not-full-qualified name of the current class without the package name. |
static String |
getFullClassNameFor(xjavadoc.XClass clazz)
Returns the full-qualified name of the current class with the package name. |
static String |
getFullSuperclassNameFor(xjavadoc.XClass clazz)
Returns the full-qualified name of the superclass of the current class. |
protected char[] |
getIndentChars(Properties attributes)
A utility method to get the blank space characters used for indenting comments. |
protected xjavadoc.XExecutableMember |
getXExecutableMemberForMemberName(String memberName,
boolean superclasses,
int forType)
Searches for the XExecutableMember of the member with name methodName and returns it. |
protected xjavadoc.XExecutableMember |
getXExecutableMemberForMemberName(String memberName,
int forType)
Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object |
protected static boolean |
hasExecutableMember_OLD(xjavadoc.XClass clazz,
String executableMemberName,
String[] parameters,
boolean setCurrentExecutableMember,
int forType)
|
protected static boolean |
hasExecutableMember(xjavadoc.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)
|
void |
setMatchValue(String template,
Properties attributes)
Sets the vaSoulue of match variable. |
String |
skipToken(Properties attributes)
Skips current token. |
Methods inherited from class xdoclet.template.TemplateTagHandler |
getXJavaDoc, setXJavaDoc |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static String currentToken
protected static StringTokenizer tagTokenizer
protected static String matchPattern
Constructor Detail |
public AbstractProgramElementTagsHandler()
Method Detail |
public static String getClassNameFor(xjavadoc.XClass clazz)
clazz
- Description of Parameter
public static String getFullClassNameFor(xjavadoc.XClass clazz)
clazz
- Description of Parameter
public static String getFullSuperclassNameFor(xjavadoc.XClass clazz)
clazz
- Description of Parameter
public static Collection getAllClasses()
protected static boolean hasExecutableMember_OLD(xjavadoc.XClass clazz, String executableMemberName, String[] parameters, boolean setCurrentExecutableMember, int forType) throws XDocletException
clazz
- executableMemberName
- parameters
- setCurrentExecutableMember
- forType
-
XDocletException
protected static Object[] makeCopyOfArray(Object[] objects)
objects
-
protected static boolean hasExecutableMember(xjavadoc.XClass clazz, String executableMemberName, String[] parameters, boolean setCurrentExecutableMember, int forType) throws XDocletException
XDocletException
public void setMatchValue(String template, Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic String matchValue() throws XDocletException
XDocletException
- Description of Exceptionpublic String currentToken(Properties attributes) throws XDocletException
attributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic String skipToken(Properties attributes) throws XDocletException
attributes
- The attributes of the template tag
XDocletException
- Description of Exceptionprotected xjavadoc.XExecutableMember getXExecutableMemberForMemberName(String memberName, int forType) throws XDocletException
memberName
- Describe what the parameter doesforType
- Describe what the parameter does
XDocletException
- Describe the exceptionprotected xjavadoc.XExecutableMember getXExecutableMemberForMemberName(String memberName, boolean superclasses, int forType) throws XDocletException
memberName
- superclasses
- Search superclasses.forType
-
XDocletException
protected char[] getIndentChars(Properties attributes)
attributes
- The attributes of the template tag
MethodTagsHandler.methodComment(java.util.Properties)
,
ClassTagsHandler.classComment(java.util.Properties)
protected String exceptionList(Properties attributes, int forType) throws XDocletException
attributes
- Describe what the parameter doesforType
- Describe what the parameter does
XDocletException
- Describe the exceptionprotected void forAllMemberTagTokens(String template, Properties attributes, int for_type) throws XDocletException
template
- Describe what the parameter doesattributes
- Describe what the parameter doesfor_type
- Describe what the parameter does
XDocletException
- Describe the exceptionprotected void forAllMemberTags(String template, Properties attributes, int forType, String resourceKey, String[] arguments) throws XDocletException
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
XDocletException
- Describe the exceptionprotected String memberComment(Properties attributes, int forType) throws XDocletException
attributes
- Describe what the parameter doesforType
- Describe what the parameter does
XDocletException
- Describe the exceptionprotected String firstSentenceDescriptionOfCurrentMember(xjavadoc.XMember member) throws XDocletException
member
- Describe what the parameter does
XDocletException
- Describe the exceptionprotected 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
XDocletException
- Describe the exceptionprotected String checkForWrap(String pText)
pText
- Description of Parameter
|
http://xdoclet.sourceforge.net/ | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |