com.apporiented.rest.apidoc.factory

Class JAXBModelDocFactory

java.lang.Object

com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

All Implemented Interfaces:

ModelDocumentationFactory

public class JAXBModelDocFactory
extends Object
implements ModelDocumentationFactory

Documentation factory that creates a documentation model based on internal API annoations and JAXB annotations.

Author:

Lars Behnke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JAXBModelDocFactory.ClassInfo

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME
static String	XML_NODE_ATTR
static String	XML_NODE_ELEM
static String	XML_NODE_ELEM_WRAPPER

Constructor Summary

Constructors

Constructor and Description
JAXBModelDocFactory()

Method Summary

Modifier and Type	Method and Description
ApiModelDocModel	createModelDocModel(Class clazz)
ApiDocModelRef	createModelRef(Class<?> objectType, Type genericObjectType)
protected String	createModelReferenceId(Class<?> clazz)

Methods inherited from class java.lang.Object

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

Field Detail

XML_NODE_ATTR

public static final String XML_NODE_ATTR

See Also:

Constant Field Values

XML_NODE_ELEM

public static final String XML_NODE_ELEM

See Also:

Constant Field Values

XML_NODE_ELEM_WRAPPER

public static final String XML_NODE_ELEM_WRAPPER

See Also:

Constant Field Values

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

Constant Field Values

Constructor Detail

JAXBModelDocFactory

public JAXBModelDocFactory()

Method Detail

createModelDocModel

public ApiModelDocModel createModelDocModel(Class clazz)

Specified by:

createModelDocModel in interface ModelDocumentationFactory

createModelRef

public ApiDocModelRef createModelRef(Class<?> objectType,
                                     Type genericObjectType)

Specified by:

createModelRef in interface ModelDocumentationFactory

createModelReferenceId

protected String createModelReferenceId(Class<?> clazz)