com.carma.swagger.doclet.parser

Class AnnotationParser

java.lang.Object

com.carma.swagger.doclet.parser.AnnotationParser

public class AnnotationParser
extends Object

The AnnotationParser represents a utility class for reading values from annotations

Version:

$Id$

Constructor Summary

Constructors

Constructor and Description
AnnotationParser(com.sun.javadoc.Parameter parameter, DocletOptions options) This creates an AnnotationParser for a parameter
AnnotationParser(com.sun.javadoc.ProgramElementDoc element, DocletOptions options) This creates an AnnotationParser for a method/field

Method Summary

Methods

Modifier and Type	Method and Description
List<com.sun.javadoc.ClassDoc>	getAnnotationArrayTypes(String qualifiedAnnotationType, String key, String subKey) This gets a list of string values from an annotations field that is itself an array of annotations
com.sun.javadoc.ClassDoc[]	getAnnotationClassDocValues(String qualifiedAnnotationType, String key) This gets the values of an annotation as class docs
String	getAnnotationValue(Collection<String> qualifiedAnnotationTypes, String... keys) This gets the value of the first annotation with the given FQN and attribute named key
String	getAnnotationValue(String qualifiedAnnotationType, String... keys) This gets the value of the annotation with the given FQN and attribute named key
String[]	getAnnotationValues(String qualifiedAnnotationType, String key) This gets the values of an annotation as strings
boolean	isAnnotatedBy(String qualifiedAnnotationType) This gets whether this is annotated by the given annotation
boolean	isAnnotatedByPrefix(String qualifiedAnnotationTypePrefix) This gets whether this is annotated by an annotation that starts with the given prefix

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationParser

public AnnotationParser(com.sun.javadoc.ProgramElementDoc element,
                DocletOptions options)

This creates an AnnotationParser for a method/field

Parameters:

element - The method/field javadoc item

options - The doclet options

AnnotationParser

public AnnotationParser(com.sun.javadoc.Parameter parameter,
                DocletOptions options)

This creates an AnnotationParser for a parameter

Parameters:

parameter - The parameter javadoc item

options - The doclet options

Method Detail

getAnnotationValue

public String getAnnotationValue(Collection<String> qualifiedAnnotationTypes,
                        String... keys)

This gets the value of the first annotation with the given FQN and attribute named key

Parameters:

qualifiedAnnotationTypes - The FQN of the annotations to get the value of

keys - The name of the attribute(s) of the annotation to get the value of

Returns:

The value of the first annotation with the given FQN and attribute named key or null if none matched

getAnnotationValue

public String getAnnotationValue(String qualifiedAnnotationType,
                        String... keys)

This gets the value of the annotation with the given FQN and attribute named key

Parameters:

qualifiedAnnotationType - The FQN of the annotation to get the value of

keys - The name of the attribute(s) of the annotation to get the value of

Returns:

The value of the given named attribute of the given annotation

getAnnotationClassDocValues

public com.sun.javadoc.ClassDoc[] getAnnotationClassDocValues(String qualifiedAnnotationType,
                                                     String key)

This gets the values of an annotation as class docs

Parameters:

qualifiedAnnotationType - The FQN of the annotation

key - The field name of the annotation to get

Returns:

The values or null if none were found

getAnnotationValues

public String[] getAnnotationValues(String qualifiedAnnotationType,
                           String key)

This gets the values of an annotation as strings

Parameters:

qualifiedAnnotationType - The FQN of the annotation

key - The field name of the annotation to get

Returns:

The values or null if none were found

getAnnotationArrayTypes

public List<com.sun.javadoc.ClassDoc> getAnnotationArrayTypes(String qualifiedAnnotationType,
                                                     String key,
                                                     String subKey)

This gets a list of string values from an annotations field that is itself an array of annotations

Parameters:

qualifiedAnnotationType - The fqn of the annotation

key - The key of the annotation field that is the array of annotations

subKey - The key inside each of the annotations in the array that we want to get the value of

Returns:

A list of string of values

isAnnotatedBy

public boolean isAnnotatedBy(String qualifiedAnnotationType)

This gets whether this is annotated by the given annotation

Parameters:

qualifiedAnnotationType - The annotation type to check for

Returns:

True if this is annotated by the given annotation

isAnnotatedByPrefix

public boolean isAnnotatedByPrefix(String qualifiedAnnotationTypePrefix)

This gets whether this is annotated by an annotation that starts with the given prefix

Parameters:

qualifiedAnnotationTypePrefix - The annotation type prefix to check for

Returns:

True if this is annotated by an annotation that starts with the given prefix