de.unkrig.commons.doclet

Class Tags

java.lang.Object

de.unkrig.commons.doclet.Tags

public final class Tags
extends java.lang.Object

Utility methods related to doclet tags.

Method Summary

Modifier and Type	Method and Description
static java.lang.Boolean	optionalBooleanTag(com.sun.javadoc.Doc doc, java.lang.String tagName, com.sun.javadoc.DocErrorReporter docErrorReporter) Verifies that the named tag exists at most once, and returns it value, converted to Boolean
static java.lang.String	optionalTag(com.sun.javadoc.Doc doc, java.lang.String tagName, com.sun.javadoc.DocErrorReporter docErrorReporter) Verifies that the named block tag exists at most once, and returns its text.
static java.lang.String	optionalTag(com.sun.javadoc.Doc doc, java.lang.String tagName, java.lang.String defaulT, com.sun.javadoc.DocErrorReporter docErrorReporter) Verifies that the named block tag exists at most once and returns its text.
static java.lang.Boolean	requiredBooleanTag(com.sun.javadoc.Doc doc, java.lang.String tagName, com.sun.javadoc.DocErrorReporter docErrorReporter) Verifies that the named tag exists exactly once, and returns it value, converted to Boolean
static java.lang.String	requiredTag(com.sun.javadoc.Doc doc, java.lang.String tagName, com.sun.javadoc.DocErrorReporter docErrorReporter) Verifies that the named block tag exists exactly once, and returns its text.

Methods inherited from class java.lang.Object

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

Method Detail

optionalBooleanTag

@Nullable
public static java.lang.Boolean optionalBooleanTag(com.sun.javadoc.Doc doc,
                                                              java.lang.String tagName,
                                                              com.sun.javadoc.DocErrorReporter docErrorReporter)

Verifies that the named tag exists at most once, and returns it value, converted to Boolean

Returns:

null iff the tag does not exist

optionalTag

@Nullable
public static java.lang.String optionalTag(com.sun.javadoc.Doc doc,
                                                      java.lang.String tagName,
                                                      com.sun.javadoc.DocErrorReporter docErrorReporter)

Verifies that the named block tag exists at most once, and returns its text.

Returns:

null iff the tag does not exist

optionalTag

public static java.lang.String optionalTag(com.sun.javadoc.Doc doc,
                                           java.lang.String tagName,
                                           java.lang.String defaulT,
                                           com.sun.javadoc.DocErrorReporter docErrorReporter)

Verifies that the named block tag exists at most once and returns its text.

Returns:

defaulT iff the tag does not exist

requiredBooleanTag

public static java.lang.Boolean requiredBooleanTag(com.sun.javadoc.Doc doc,
                                                   java.lang.String tagName,
                                                   com.sun.javadoc.DocErrorReporter docErrorReporter)

Verifies that the named tag exists exactly once, and returns it value, converted to Boolean

requiredTag

public static java.lang.String requiredTag(com.sun.javadoc.Doc doc,
                                           java.lang.String tagName,
                                           com.sun.javadoc.DocErrorReporter docErrorReporter)

Verifies that the named block tag exists exactly once, and returns its text.