|
|||||||||||
| 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
xdoclet.tagshandler.ClassTagsHandler
| Field Summary | |
protected static DateFormat |
dateFormatter
Used for setting the timestamp for xdoclet-generated marker in generated files. |
protected static Calendar |
now
|
| Fields inherited from class xdoclet.tagshandler.AbstractProgramElementTagsHandler |
currentToken, matchPattern, tagTokenizer |
| Fields inherited from class xdoclet.XDocletTagSupport |
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER |
| Constructor Summary | |
ClassTagsHandler()
|
|
| Method Summary | |
String |
classComment(Properties attributes)
The comment for the current class. |
String |
classCommentTags(Properties attributes)
The javadoc comment tags for the current class (plus xdoclet-generated). |
String |
classCommentText(Properties attributes)
The text of the javadoc comment for the current class. |
String |
className()
Returns the not-full-qualified name of the current class without the package name. |
void |
classOf(String template)
Returns the not-full-qualified name of the full-qualified class name specified in the body of this tag. |
String |
classTagValue(Properties attributes)
Iterates over all class tags with the specified tagName and evaluates the body of the tag for each class tag. |
String |
classTagValueMatch(Properties attributes)
Sets the value of match variable. |
String |
firstSentenceDescription(Properties attributes)
Return standard javadoc of current class. |
void |
forAllClasses(String template,
Properties attributes)
Iterates over all classes loaded by javadoc and evaluates the body of the tag for each class. |
void |
forAllClassTags(String template,
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(String template,
Properties attributes)
Iterates over all tokens in specified class tag with the name tagName and evaluates the body for every token. |
void |
forAllDistinctClassTags(String template,
Properties attributes)
Iterates over all tags named according to tagName in a non-duplicated manner. |
static void |
forAllDistinctClassTags(TemplateEngine engine,
String template,
String tagName,
String paramName)
Iterates over all tags named according to tagName in a non-duplicated manner. |
String |
fullClassName()
Returns the full-qualified name of the superclass of the current class. |
String |
fullSuperclassName()
Returns the full-qualified name of the superclass of the current class. |
static String |
getClassNameFor(xjavadoc.XClass clazz)
Deprecated. use XClass.name() |
static String |
getFullClassNameFor(xjavadoc.XClass clazz)
Deprecated. use XClass.qualifiedName() |
void |
ifClassTagValueEquals(String template,
Properties attributes)
Evaluates the body if value for the class tag equals the specified value. |
void |
ifClassTagValueMatches(String template,
Properties attributes)
Evaluate the body if the match variable equals with the value of the specified tag/parameter. |
void |
ifClassTagValueNotEquals(String template,
Properties attributes)
Evaluates the body if value for the class tag not equals the specified value. |
void |
ifDoesntHaveClassTag(String template,
Properties attributes)
Evaluates the body if current class doesn't have at least one tag with the specified name. |
void |
ifHasClassTag(String template,
Properties attributes)
Evaluates the body if current class has at least one tag with the specified name. |
void |
ifIsClassAbstract(String template)
Evaluate the body block if current class is abstract. |
void |
ifIsClassNotAbstract(String template)
Evaluate the body block if current class is not abstract. |
String |
importedList(Properties attributes)
Deprecated. Make sure the template file uses full qualified class names everywhere instead. |
String |
modifiers()
Describe what the method does |
void |
pushClass(String template,
Properties attributes)
Pushes the class specified by value parameter to top of stack making it the current class. |
String |
symbolicClassName()
Returns the symbolic name of the current class. |
| 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 final DateFormat dateFormatter
protected static final Calendar now
| Constructor Detail |
public ClassTagsHandler()
| 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 void forAllDistinctClassTags(TemplateEngine engine,
String template,
String tagName,
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 wrong
public void forAllDistinctClassTags(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - if something goes wrong
public String className()
throws XDocletException
XDocletException - Description of Exception
public String fullClassName()
throws XDocletException
XDocletException - Description of Exception
public String fullSuperclassName()
throws XDocletException
XDocletException - Description of Exception
public void classOf(String template)
throws XDocletException
template - The body of the block tag
XDocletException - Description of Exception
public void ifIsClassAbstract(String template)
throws XDocletException
template - The body of the block tag
XDocletException - Description of ExceptionifIsClassNotAbstract(java.lang.String)
public void ifIsClassNotAbstract(String template)
throws XDocletException
template - The body of the block tag
XDocletException - Description of ExceptionifIsClassAbstract(java.lang.String)
public void pushClass(String template,
Properties attributes)
throws XDocletException
attributes - The attributes of the template tagtemplate - The body of the block tag
XDocletException - Description of Exception
public void forAllClasses(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public String modifiers()
throws XDocletException
XDocletException - Describe the exception
public String symbolicClassName()
throws XDocletException
XDocletException - Description of Exception
public void ifDoesntHaveClassTag(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public void ifHasClassTag(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public void ifClassTagValueMatches(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public void ifClassTagValueEquals(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public void ifClassTagValueNotEquals(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public String classTagValue(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of Exception
public String classTagValueMatch(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of Exception
public void forAllClassTags(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public void forAllClassTagTokens(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public String classComment(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of ExceptionMethodTagsHandler.methodComment(java.util.Properties),
classCommentText(java.util.Properties),
classCommentTags(java.util.Properties)
public String classCommentText(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of ExceptionMethodTagsHandler.methodComment(java.util.Properties),
classComment(java.util.Properties)
public String classCommentTags(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of ExceptionMethodTagsHandler.methodComment(java.util.Properties),
classComment(java.util.Properties)
public String firstSentenceDescription(Properties attributes)
throws XDocletException
attributes -
XDocletException - Description of Exception
public String importedList(Properties attributes)
throws XDocletException
attributes -
XDocletException - Description of Exception
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||