com.carma.swagger.doclet.translator

Class FirstNotNullTranslator

java.lang.Object

com.carma.swagger.doclet.translator.FirstNotNullTranslator

All Implemented Interfaces:

Translator

public class FirstNotNullTranslator
extends Object
implements Translator

The FirstNotNullTranslator represents a chain of translators. It will iterate through each one in the chain and return the results of the first translator that does not return null.

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
FirstNotNullTranslator() This creates a FirstNotNullTranslator with no links

Method Summary

Methods

Modifier and Type	Method and Description
FirstNotNullTranslator	addNext(Translator link) This adds another translator link to the chain of translators
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

FirstNotNullTranslator

public FirstNotNullTranslator()

This creates a FirstNotNullTranslator with no links

Method Detail

addNext

public FirstNotNullTranslator addNext(Translator link)

This adds another translator link to the chain of translators

Parameters:

link - The translator to add

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)