de.unkrig.commons.doclet

Class Annotations

java.lang.Object

de.unkrig.commons.doclet.Annotations

public final class Annotations
extends java.lang.Object

Utility methods related to doclets and annotations.

Method Summary

Modifier and Type	Method and Description
static com.sun.javadoc.AnnotationDesc	get(com.sun.javadoc.ProgramElementDoc doc, java.lang.Class<?> annotationType, com.sun.javadoc.RootDoc rootDoc)
static com.sun.javadoc.AnnotationDesc	get(com.sun.javadoc.ProgramElementDoc doc, com.sun.javadoc.ClassDoc annotationType)
static com.sun.javadoc.AnnotationDesc	get(com.sun.javadoc.ProgramElementDoc doc, java.lang.String annotationTypeSimpleName)
static java.lang.Object	getAnnotationElementValue(com.sun.javadoc.AnnotationDesc annotationDesc, java.lang.String elementName) Determines and returns the value of the named element.
static java.lang.Object	getAnnotationValue(com.sun.javadoc.AnnotationValue value) Determines and returns the value of an AnnotationValue.
static <T> T	getElementValue(com.sun.javadoc.AnnotationDesc annotationDesc, java.lang.String elementName, java.lang.Class<T> clasS)

Methods inherited from class java.lang.Object

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

Method Detail

get

@Nullable
public static com.sun.javadoc.AnnotationDesc get(com.sun.javadoc.ProgramElementDoc doc,
                                                            java.lang.String annotationTypeSimpleName)

Returns:

The annotation with the given simple (unqualified) type name, or null iff the doc is not annotated with the annotationTypeSimpleName

get

@Nullable
public static com.sun.javadoc.AnnotationDesc get(com.sun.javadoc.ProgramElementDoc doc,
                                                            com.sun.javadoc.ClassDoc annotationType)

Returns:

The annotation with the given annotationType, or null iff the doc is not annotated with the annotationType

get

@Nullable
public static com.sun.javadoc.AnnotationDesc get(com.sun.javadoc.ProgramElementDoc doc,
                                                            java.lang.Class<?> annotationType,
                                                            com.sun.javadoc.RootDoc rootDoc)
                                                     throws Longjump

Returns:

The annotation with the annotationType, or null iff the doc is not annotated with the annotationType

Throws:

Longjump - The annotationType is not on JAVADOC's source path or class path

getElementValue

@Nullable
public static <T> T getElementValue(com.sun.javadoc.AnnotationDesc annotationDesc,
                                               java.lang.String elementName,
                                               java.lang.Class<T> clasS)

Returns:

The value of the element with the given name and type, or null

getAnnotationElementValue

@Nullable
public static java.lang.Object getAnnotationElementValue(com.sun.javadoc.AnnotationDesc annotationDesc,
                                                                    java.lang.String elementName)

Determines and returns the value of the named element.

This can be:

• A wrapper for a primitive type
• A string
• A Type (representing a class literal)
• A FieldDoc (representing an enum constant)
• An AnnotationDesc (representing what??)
• An array of any of these (including the case of nested arrays)

getAnnotationValue

@Nullable
public static java.lang.Object getAnnotationValue(com.sun.javadoc.AnnotationValue value)

Determines and returns the value of an AnnotationValue.

Returns:

See getAnnotationElementValue(AnnotationDesc, String)