xdoclet.util
Class DocletUtil

java.lang.Object
  |
  +--xdoclet.util.DocletUtil

public final class DocletUtil

extends java.lang.Object

Version:

$Revision: 1.14 $

Author:

Ara Abrahamian (ara_e@email.com)

Constructor Summary

DocletUtil()

Method Summary

static com.sun.javadoc.Tag[]	getTagsByName(com.sun.javadoc.ClassDoc clazz, java.lang.String tag_name)
static com.sun.javadoc.Tag[]	getTagsByName(com.sun.javadoc.ClassDoc clazz, java.lang.String tag_name, boolean superclasses)
static com.sun.javadoc.Tag[]	getTagsByName(com.sun.javadoc.MemberDoc doc, java.lang.String tag_name)
static java.lang.String	getText(com.sun.javadoc.Doc doc, java.lang.String tagName)
static java.lang.String	getText(com.sun.javadoc.Doc doc, java.lang.String tagName, boolean superclasses) Returns the entire body (parameters etc) of a tag within a supplied Doc context as text.
static java.lang.String	getText(com.sun.javadoc.Tag tag)
static boolean	hasTag(com.sun.javadoc.Doc doc, java.lang.String tag)
static boolean	hasTag(com.sun.javadoc.Doc doc, java.lang.String tag_name, boolean superclasses)
static java.lang.String[]	tokenizeDelimitedToArray(java.lang.String delimited, java.lang.String delimiter) Return an array of String from a String containing delimited values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocletUtil

public DocletUtil()

Method Detail

getText

public static java.lang.String getText(com.sun.javadoc.Doc doc,
                                       java.lang.String tagName)
                                throws XDocletException

getText

public static java.lang.String getText(com.sun.javadoc.Doc doc,
                                       java.lang.String tagName,
                                       boolean superclasses)
                                throws XDocletException

Returns the entire body (parameters etc) of a tag within a supplied Doc context as text.

Parameters:

doc - The Doc subclass (ClassDoc, MethodDoc, ConstructorDoc or FieldDoc) to search for the tag.

tagName - The name of the tag. Can be in namespace:tag or namespace.tag format.

superclasses - Whether superclass definitions should also be searched.

Returns:

The tag body

Throws:

XDocletException -

getText

public static java.lang.String getText(com.sun.javadoc.Tag tag)

getTagsByName

public static com.sun.javadoc.Tag[] getTagsByName(com.sun.javadoc.ClassDoc clazz,
                                                  java.lang.String tag_name)

getTagsByName

public static com.sun.javadoc.Tag[] getTagsByName(com.sun.javadoc.ClassDoc clazz,
                                                  java.lang.String tag_name,
                                                  boolean superclasses)

getTagsByName

public static com.sun.javadoc.Tag[] getTagsByName(com.sun.javadoc.MemberDoc doc,
                                                  java.lang.String tag_name)

hasTag

public static boolean hasTag(com.sun.javadoc.Doc doc,
                             java.lang.String tag)

hasTag

public static boolean hasTag(com.sun.javadoc.Doc doc,
                             java.lang.String tag_name,
                             boolean superclasses)

tokenizeDelimitedToArray

public static java.lang.String[] tokenizeDelimitedToArray(java.lang.String delimited,
                                                          java.lang.String delimiter)

Return an array of String from a String containing delimited values. For example "a,b,c" will return a String[3] {"a","b","c"}.

Parameters:

delimited - the String value to tokenize

delimiter - the delimiter ("," or ";" for example)

Returns:

an array of String delimited value