com.carma.swagger.doclet.translator

Class NameBasedTranslator

java.lang.Object

com.carma.swagger.doclet.translator.NameBasedTranslator

All Implemented Interfaces:

Translator

public class NameBasedTranslator
extends Object
implements Translator

The NameBasedTranslator represents a translator that looks up names of items based on their javadoc signature

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
NameBasedTranslator(DocletOptions options) This creates a NameBasedTranslator

Method Summary

Methods

Modifier and Type	Method and Description
Translator.OptionalName	fieldName(com.sun.javadoc.FieldDoc field)
Translator.OptionalName	methodName(com.sun.javadoc.MethodDoc method)
Translator.OptionalName	parameterTypeName(boolean multipart, com.sun.javadoc.Parameter parameter, com.sun.javadoc.Type paramType)
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

NameBasedTranslator

public NameBasedTranslator(DocletOptions options)

This creates a NameBasedTranslator

Parameters:

options -

Method Detail

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,
                               com.sun.javadoc.ClassDoc[] views)

Specified by:

typeName in interface Translator

See Also:

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

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)