|
|||||||||||
| 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.ConstructorTagsHandler
| Field Summary |
| 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 | |
ConstructorTagsHandler()
|
|
| Method Summary | |
String |
constructorComment(Properties attributes)
The comment for the current constructor. |
String |
constructorName(Properties attributes)
Returns the name of the current constructor. |
String |
constructorTagValue(Properties attributes)
Iterates over all constructor tags with the specified tagName for the current constructor probably inside of a forAllConstructorTags body. |
String |
currentConstructorName()
Returns the current constructor name. |
String |
exceptionList(Properties attributes)
Iterates over all exceptions thrown by the current constructor and returns a string containing definition of all those exceptions. |
void |
executeAndRestoreConstructor(String template,
Properties attributes)
Evaluate the current block, and then restore the current constructor before continuing. |
String |
firstSentenceDescriptionOfCurrentConstructor()
Return standard javadoc of current constructor. |
void |
forAllClassConstructors(String template,
Properties attributes)
Loops through all constructors for all classes after first sorting all the constructors. |
void |
forAllConstructors(String template,
Properties attributes)
Iterates over all constructors of current class and evaluates the body of the tag for each constructor. |
void |
forAllConstructorTags(String template,
Properties attributes)
Iterates over all tags of current constructor and evaluates the body of the tag for each constructor. |
void |
forAllConstructorTagTokens(String template,
Properties attributes)
Iterates over all tokens in current constructor tag with the name tagName and evaluates the body for every token. |
void |
ifConstructorTagValueEquals(String template,
Properties attributes)
Evaluates the body if value for the constructor tag equals the specified value. |
void |
ifConstructorTagValueNotEquals(String template,
Properties attributes)
Evaluates the body if value for the constructor tag not equals the specified value. |
void |
ifDoesntHaveConstructor(String template,
Properties attributes)
Evaluate the body if current class doesn't have a constructor with the specified name+parameters. |
void |
ifDoesntHaveConstructorTag(String template,
Properties attributes)
Evaluates the body if current constructor doesn't have at least one tag with the specified name. |
void |
ifHasConstructor(String template,
Properties attributes)
Evaluate the body if current class has a constructor with the specified name+parameters. |
void |
ifHasConstructorTag(String template,
Properties attributes)
Evaluates the body if current constructor has at least one tag with the specified name. |
String |
modifiers()
Describe what the method does |
void |
setCurrentConstructor(String template,
Properties attributes)
Evaluate the body if current class has a constructor with the specified name+parameters. |
| 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 |
| Constructor Detail |
public ConstructorTagsHandler()
| Method Detail |
public void setCurrentConstructor(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of ExceptionifHasConstructor(java.lang.String,java.util.Properties)
public String constructorComment(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of ExceptionClassTagsHandler.classComment(java.util.Properties)
public String exceptionList(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of Exception
public void forAllClassConstructors(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 forAllConstructors(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 ifDoesntHaveConstructorTag(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 ifHasConstructorTag(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 executeAndRestoreConstructor(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 ifConstructorTagValueEquals(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 ifConstructorTagValueNotEquals(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 constructorTagValue(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of Exception
public void forAllConstructorTags(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 forAllConstructorTagTokens(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 firstSentenceDescriptionOfCurrentConstructor()
throws XDocletException
XDocletException - Description of Exception
public String modifiers()
throws XDocletException
XDocletException - Describe the exception
public String constructorName(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of Exception
public String currentConstructorName()
throws XDocletException
XDocletException - Description of Exception
public void ifHasConstructor(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of ExceptionifDoesntHaveConstructor(java.lang.String,java.util.Properties)
public void ifDoesntHaveConstructor(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of ExceptionifHasConstructor(java.lang.String,java.util.Properties)
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||