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