xdoclet
public abstract class XDocletTagSupport extends TemplateTagHandler
Version: $Revision: 1.61 $
UNKNOWN: October 12, 2001
Field Summary | |
---|---|
static int | FOR_CLASS |
static int | FOR_CONSTRUCTOR |
static int | FOR_FIELD |
static int | FOR_METHOD |
protected static String | PARAMETER_DELIMITER
Default delimiter used inside a xdoclet tag attribute. |
Method Summary | |
---|---|
protected static String | delimit(String attributeValue, Properties attributes) |
protected static String | expandClassName(String value, Properties attributes) |
void | generate(String template) |
static XClass | getCurrentClass()
Provides the current class in the XDoclet build, or null if there is no current class.
|
static XTag | getCurrentClassTag() |
static XConstructor | getCurrentConstructor()
Provides the current constructor in the XDoclet build, or null if there is no current constructor.
|
static XField | getCurrentField()
Provides the current field in the XDoclet build, or null if there is no current field.
|
static XTag | getCurrentFieldTag() |
static XMethod | getCurrentMethod()
Provides the current method in the XDoclet build, or null if there is no current method.
|
static XTag | getCurrentMethodTag() |
static XPackage | getCurrentPackage()
Provides the current package in the XDoclet build, or null if there is no current package.
|
protected static DocletContext | getDocletContext() |
TemplateEngine | getEngine()
Gets the Engine attribute of the TemplateTagHandler object.
|
protected static String | getExpandedDelimitedTagValue(Properties attributes, int forType)
The getExpandedDelimitedTagValue method returns a delimited version with class names expanded if
requested of the tag value.
|
protected static String | getTagValue(Properties attributes, int forType)
Return the Value of a tag specified in a Properties object. |
protected static String | getTagValue(int forType, String tagName, String paramName, String validValues, String defaultValue, boolean superclasses, boolean mandatory)
Gets the TagValue attribute of the XDocletTagSupport class
|
protected static String | getTagValue(int forType, XDoc doc, String tagName, String paramName, String validValues, String defaultValue, boolean superclasses, boolean mandatory) |
protected boolean | hasHavingClassTag(XClass clazz)
Tests whether the passed class has the tag which is specfied in the havingClassTag attribute of the
current subtask.
|
protected static boolean | hasTag(Properties attributes, int forType)
A utility method used by ifHasClassTag/ifDoesntHaveClassTag and ifHasMethodTag/ifDoesntHaveMethodTag, return true
if at least one tag exists with the specified name.
|
protected static boolean | isTagValueEqual(Properties attributes, int forType)
A utility method used by ifMethodTagValueEquals/ifMethodTagValueNotEquals and
ifClassTagValueEquals/ifClassTagValueNotEquals, return true if the value of the tag/XParameter equals with value.
|
protected static void | mandatoryParamNotFound(XDoc doc, String paramName, String tagName)
Throws an XDocletException exception to stop the build process. |
protected void | mandatoryTemplateTagParamNotFound(String templateTagName, String paramName)
Throws an XDocletException exception to stop the build process. |
protected String | modifiers(int forType)
Return the modifiers (static, private, etc.) for the current program element of the specified type.
|
static XClass | popCurrentClass()
Pop the current class off the top of the class stack.
|
static XClass | pushCurrentClass(XClass clazz)
Push the specified class to the top of the current class stack making it effectively the current class.
|
static void | setCurrentClass(XClass clazz)
Sets current class to clazz by clearing currentClassStack stack and pushing clazz
into top of it.
|
static void | setCurrentClassTag(XTag currentTag)
Sets the current class tag.
|
static void | setCurrentConstructor(XConstructor constructor)
Set the current constructor.
|
static void | setCurrentField(XField field)
Set the current field.
|
static void | setCurrentFieldTag(XTag currentTag)
Sets the current field tag.
|
static void | setCurrentMethod(XMethod method)
Set the current method.
|
static void | setCurrentMethodTag(XTag currentTag)
Sets the current method tag.
|
static void | setCurrentPackage(XPackage pakkage)
Set the current package.
|
Parameters: attributeValue Describe what the parameter does attributes Describe what the parameter does
Returns: Describe the return value
UNKNOWN: fix the () equals test, it is not nice. Test : finder Home definition on AccountBean
Parameters: template
Throws: XDocletException
UNKNOWN: throw TemplateException instead
Returns: current class
See Also: XDocletTagSupport XDocletTagSupport
Returns: The current tag.
Returns: current constructor
See Also: XDocletTagSupport
Returns: current field
See Also: XDocletTagSupport
Returns: The current tag.
Returns: current method
See Also: XDocletTagSupport
Returns: The current tag.
Returns: current package
Returns: the context object casted to DocletContext
Returns: The Engine value
getExpandedDelimitedTagValue
method returns a delimited version with class names expanded if
requested of the tag value.
Parameters: attributes a Properties
value forType an int
value
Returns: a String
value
Throws: XDocletException if an error occurs
Parameters: attributes The attributes of the template tag forType if FOR_CLASS, then a fifth property superclasses is searched, if this is set to true, then the tag is also searched in all superclasses of current class. If forType is set to FOR_METHOD or FOR_CONSTRUCTOR or FOR_FIELD, current method or field is searched for the tag.
Returns: The TagValue value
Throws: XDocletException Description of Exception
Parameters: forType Describe what the parameter does tagName Describe what the parameter does paramName Describe what the parameter does validValues Describe what the parameter does defaultValue Describe what the parameter does superclasses Describe what the parameter does mandatory Describe what the parameter does
Returns: The TagValue value
Throws: XDocletException Describe the exception
Parameters: forType doc Describe what the parameter does tagName Describe what the parameter does paramName Describe what the parameter does validValues Describe what the parameter does defaultValue Describe what the parameter does superclasses Describe what the parameter does mandatory Describe what the parameter does
Returns: The TagValue value
Throws: XDocletException Describe the exception
UNKNOWN: (Aslak) maybe this method ought to be moved to xjavadoc.XDoc? Not a big deal though.
havingClassTag
attribute of the
current subtask.
Parameters: clazz the Class to check
Returns: true
if the current subtask has no havingClassTag
or the passed class has
a tag with the same name as the havingClassTag
attribute of the current subtask, otherwise
false
Parameters: attributes The attributes of the template tag forType
Returns: true
if matching tag found
Throws: XDocletException Description of Exception
Parameters: attributes The attributes of the template tag forType Describe what the parameter does
Returns: Description of the Returned Value
Throws: XDocletException Description of Exception
Parameters: doc member javadoc reference paramName tag parameter name tagName tag name
Throws: XDocletException Description of Exception
Parameters: templateTagName tag name paramName tag parameter name
Throws: XDocletException
Parameters: forType FOR_XXX type constant
Returns: modifiers
Throws: XDocletException Describe the exception
Returns: The class popped off the top of the stack.
See Also: XDocletTagSupport XDocletTagSupport
Parameters: clazz The class to push onto the top of the class stack.
Returns: The class on the top of the stack.
See Also: XDocletTagSupport XDocletTagSupport
clazz
by clearing currentClassStack
stack and pushing clazz
into top of it.
Parameters: clazz The class to make the current class
See Also: getCurrentClass
Parameters: currentTag The tag to make the current class tag
Parameters: constructor The constructor to make the current constructor
See Also: XDocletTagSupport
Parameters: field The field to make the current field
See Also: XDocletTagSupport
Parameters: currentTag The tag to make the current field tag
Parameters: method The method to make the current method
See Also: XDocletTagSupport
Parameters: currentTag The tag to make the current method tag
Parameters: pakkage The package to make the current package
See Also: XDocletTagSupport