com.carma.swagger.doclet.translator

Class AnnotationAwareTranslator

java.lang.Object

com.carma.swagger.doclet.translator.AnnotationAwareTranslator

All Implemented Interfaces:

Translator

public class AnnotationAwareTranslator
extends Object
implements Translator

The AnnotationAwareTranslator represents a translator that can source the names from various annotations like jaxb and json ones.

Version:

$Id$

Nested Class Summary

Nested classes/interfaces inherited from interface com.carma.swagger.doclet.translator.Translator

Translator.OptionalName

Constructor Summary

Constructors

Constructor and Description
AnnotationAwareTranslator(DocletOptions options) This creates a AnnotationAwareTranslator that uses the given doclet options

Method Summary

Methods

Modifier and Type	Method and Description
AnnotationAwareTranslator	element(String qualifiedAnnotationType, String property) This adds an element annotation to this translator, these ones are used for field and method names
Translator.OptionalName	fieldName(com.sun.javadoc.FieldDoc field)
AnnotationAwareTranslator	ignore(String qualifiedAnnotationType) This adds an ignore annotation to this translator
Translator.OptionalName	methodName(com.sun.javadoc.MethodDoc method)
Translator.OptionalName	parameterTypeName(boolean multipart, com.sun.javadoc.Parameter parameter, com.sun.javadoc.Type paramType)
AnnotationAwareTranslator	rootElement(String qualifiedAnnotationType, String property) This adds an root annotation to this translator, these ones are used for class type names
Translator.OptionalName	typeName(com.sun.javadoc.Type type)
Translator.OptionalName	typeName(com.sun.javadoc.Type type, com.sun.javadoc.ClassDoc[] views)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationAwareTranslator

public AnnotationAwareTranslator(DocletOptions options)

This creates a AnnotationAwareTranslator that uses the given doclet options

Parameters:

options - the doclet options

Method Detail

ignore

public AnnotationAwareTranslator ignore(String qualifiedAnnotationType)

This adds an ignore annotation to this translator

Parameters:

qualifiedAnnotationType - The FQN of the annotation that if present means a field is ignored e.g. JsonIgnore, XmlTransient

Returns:

this

element

public AnnotationAwareTranslator element(String qualifiedAnnotationType,
                                String property)

This adds an element annotation to this translator, these ones are used for field and method names

Parameters:

qualifiedAnnotationType - The FQN of the annotation that if present means a field/method uses this annotation's property for the name

property - The property name of the annotation to use for the field/method name

Returns:

this

rootElement

public AnnotationAwareTranslator rootElement(String qualifiedAnnotationType,
                                    String property)

This adds an root annotation to this translator, these ones are used for class type names

Parameters:

qualifiedAnnotationType - The FQN of the annotation that if present means a class type uses uses this annotation's property for the name

property - The property name of the annotation to use for the class type name

Returns:

this

typeName

public Translator.OptionalName typeName(com.sun.javadoc.Type type,
                               com.sun.javadoc.ClassDoc[] views)

Specified by:

typeName in interface Translator

See Also:

Translator.typeName(com.sun.javadoc.Type, com.sun.javadoc.ClassDoc[])

parameterTypeName

public Translator.OptionalName parameterTypeName(boolean multipart,
                                        com.sun.javadoc.Parameter parameter,
                                        com.sun.javadoc.Type paramType)

Specified by:

parameterTypeName in interface Translator

See Also:

Translator.parameterTypeName(boolean, com.sun.javadoc.Parameter, com.sun.javadoc.Type)

typeName

public Translator.OptionalName typeName(com.sun.javadoc.Type type)

Specified by:

typeName in interface Translator

See Also:

Translator.typeName(com.sun.javadoc.Type)

fieldName

public Translator.OptionalName fieldName(com.sun.javadoc.FieldDoc field)

Specified by:

fieldName in interface Translator

See Also:

Translator.fieldName(com.sun.javadoc.FieldDoc)

methodName

public Translator.OptionalName methodName(com.sun.javadoc.MethodDoc method)

Specified by:

methodName in interface Translator

See Also:

Translator.methodName(com.sun.javadoc.MethodDoc)