xdoclet.modules.caucho
public class ResinWebTagsHandler extends XDocletTagSupport
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
ResinWebTagsHandler() |
Modifier and Type | Method and Description |
---|---|
void |
forAllCurrentTagParams(java.lang.String template)
Iterates over all parameters of the current javadoc tag.
|
java.lang.String |
parameterAsElement(java.util.Properties props)
Writes the current javadoc parameter as an xml element of the form:
|
java.lang.String |
parameterAsInitParam()
Writes the current javadoc parameter as an xml element of the form:
|
java.lang.String |
parameterAsXml(java.util.Properties props)
Writes the current javadoc parameter as an element or an init-param, depending on the tag attributes; if the
parameter name is contained in the attributes, the 'element' form is used, else the 'init-parm' form.
|
java.lang.String |
parameterName()
Returns the current javadoc parameter name.
|
java.lang.String |
parameterValue()
Returns the current javadoc parameter value.
|
java.lang.String |
sourceComment()
Writes an xml comment indicating the current method or class name.
|
delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
getXJavaDoc, setXJavaDoc
public void forAllCurrentTagParams(java.lang.String template) throws XDocletException
template
- XDocletException
public java.lang.String parameterAsElement(java.util.Properties props) throws XDocletException
If the parameter maps to a non-empty value in the attributes, value is used as the xml element name instead of the javadoc parameter name.parameter-value
props
- XDocletException
public java.lang.String parameterAsInitParam() throws XDocletException
XDocletException
public java.lang.String parameterAsXml(java.util.Properties props) throws XDocletException
props
- XDocletException
parameterAsElement(java.util.Properties)
,
parameterAsInitParam()
public java.lang.String parameterName() throws XDocletException
XDocletException
public java.lang.String parameterValue() throws XDocletException
XDocletException
public java.lang.String sourceComment() throws XDocletException
XDocletException