xdoclet

Class XDocletTagSupport


public abstract class XDocletTagSupport
extends xdoclet.template.TemplateTagHandler

Field Summary

static int
FOR_CLASS
static int
FOR_CONSTRUCTOR
static int
FOR_FIELD
static int
FOR_METHOD
protected static String
PARAMETER_DELIMITER

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()
static XTag
getCurrentClassTag()
static XConstructor
getCurrentConstructor()
static XField
getCurrentField()
static XTag
getCurrentFieldTag()
static XMethod
getCurrentMethod()
static XTag
getCurrentMethodTag()
static XPackage
getCurrentPackage()
protected static xdoclet.DocletContext
getDocletContext()
xdoclet.template.TemplateEngine
getEngine()
protected static String
getExpandedDelimitedTagValue(Properties attributes, int forType)
protected static String
getTagValue(Properties attributes, int forType)
protected static String
getTagValue(int forType, String tagName, String paramName, String validValues, String defaultValue, boolean superclasses, boolean mandatory)
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)
protected static boolean
hasTag(Properties attributes, int forType)
protected static boolean
isTagValueEqual(Properties attributes, int forType)
protected static void
mandatoryParamNotFound(XDoc doc, String paramName, String tagName)
protected void
mandatoryTemplateTagParamNotFound(String templateTagName, String paramName)
protected String
modifiers(int forType)
static XClass
popCurrentClass()
static XClass
pushCurrentClass(XClass clazz)
static void
setCurrentClass(XClass clazz)
static void
setCurrentClassTag(XTag currentTag)
static void
setCurrentConstructor(XConstructor constructor)
static void
setCurrentField(XField field)
static void
setCurrentFieldTag(XTag currentTag)
static void
setCurrentMethod(XMethod method)
static void
setCurrentMethodTag(XTag currentTag)
static void
setCurrentPackage(XPackage pakkage)

Methods inherited from class xdoclet.template.TemplateTagHandler

getXJavaDoc, setXJavaDoc

Field Details

FOR_CLASS

public static final int FOR_CLASS
Field Value:
0

FOR_CONSTRUCTOR

public static final int FOR_CONSTRUCTOR
Field Value:
3

FOR_FIELD

public static final int FOR_FIELD
Field Value:
2

FOR_METHOD

public static final int FOR_METHOD
Field Value:
1

PARAMETER_DELIMITER

protected static final String PARAMETER_DELIMITER

Method Details

delimit

protected static String delimit(String attributeValue,
                                Properties attributes)

expandClassName

protected static String expandClassName(String value,
                                        Properties attributes)

generate

public void generate(String template)
            throws XDocletException

getCurrentClass

public static XClass getCurrentClass()

getCurrentClassTag

public static XTag getCurrentClassTag()

getCurrentConstructor

public static XConstructor getCurrentConstructor()

getCurrentField

public static XField getCurrentField()

getCurrentFieldTag

public static XTag getCurrentFieldTag()

getCurrentMethod

public static XMethod getCurrentMethod()

getCurrentMethodTag

public static XTag getCurrentMethodTag()

getCurrentPackage

public static XPackage getCurrentPackage()

getDocletContext

protected static xdoclet.DocletContext getDocletContext()

getEngine

public xdoclet.template.TemplateEngine getEngine()

getExpandedDelimitedTagValue

protected static String getExpandedDelimitedTagValue(Properties attributes,
                                                     int forType)
            throws XDocletException

getTagValue

protected static String getTagValue(Properties attributes,
                                    int forType)
            throws XDocletException

getTagValue

protected static String getTagValue(int forType,
                                    String tagName,
                                    String paramName,
                                    String validValues,
                                    String defaultValue,
                                    boolean superclasses,
                                    boolean mandatory)
            throws XDocletException

getTagValue

protected static String getTagValue(int forType,
                                    XDoc doc,
                                    String tagName,
                                    String paramName,
                                    String validValues,
                                    String defaultValue,
                                    boolean superclasses,
                                    boolean mandatory)
            throws XDocletException

hasHavingClassTag

protected boolean hasHavingClassTag(XClass clazz)

hasTag

protected static boolean hasTag(Properties attributes,
                                int forType)
            throws XDocletException

isTagValueEqual

protected static boolean isTagValueEqual(Properties attributes,
                                         int forType)
            throws XDocletException

mandatoryParamNotFound

protected static void mandatoryParamNotFound(XDoc doc,
                                             String paramName,
                                             String tagName)
            throws XDocletException

mandatoryTemplateTagParamNotFound

protected void mandatoryTemplateTagParamNotFound(String templateTagName,
                                                 String paramName)
            throws XDocletException

modifiers

protected String modifiers(int forType)
            throws XDocletException

popCurrentClass

public static XClass popCurrentClass()

pushCurrentClass

public static XClass pushCurrentClass(XClass clazz)

setCurrentClass

public static void setCurrentClass(XClass clazz)

setCurrentClassTag

public static void setCurrentClassTag(XTag currentTag)

setCurrentConstructor

public static void setCurrentConstructor(XConstructor constructor)

setCurrentField

public static void setCurrentField(XField field)

setCurrentFieldTag

public static void setCurrentFieldTag(XTag currentTag)

setCurrentMethod

public static void setCurrentMethod(XMethod method)

setCurrentMethodTag

public static void setCurrentMethodTag(XTag currentTag)

setCurrentPackage

public static void setCurrentPackage(XPackage pakkage)