A C D G I J M S U V W X

A

addApiModel(ApiDocModel) - Method in class com.apporiented.rest.apidoc.model.ApiDocModels

ApiDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used on your "service" class, for example controller classes in Spring MVC.

ApiDocConstants - Class in com.apporiented.rest.apidoc.utils

Constants of the API documentation module.

ApiDocConstants() - Constructor for class com.apporiented.rest.apidoc.utils.ApiDocConstants

ApiDocModel - Class in com.apporiented.rest.apidoc.model

Representation of an REST resource documentation.

ApiDocModel() - Constructor for class com.apporiented.rest.apidoc.model.ApiDocModel

ApiDocModelRef - Class in com.apporiented.rest.apidoc.model

Representation of a model reference.

ApiDocModelRef() - Constructor for class com.apporiented.rest.apidoc.model.ApiDocModelRef

ApiDocModelRef(Class<?>, String, String, String, Boolean, Boolean) - Constructor for class com.apporiented.rest.apidoc.model.ApiDocModelRef

ApiDocModels - Class in com.apporiented.rest.apidoc.model

Model of a documentation of all REST resources.

ApiDocModels() - Constructor for class com.apporiented.rest.apidoc.model.ApiDocModels

ApiErrorDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used inside an annotations of type ApiErrorsDoc

ApiErrorDocModel - Class in com.apporiented.rest.apidoc.model

Model of an API error documentation.

ApiErrorDocModel() - Constructor for class com.apporiented.rest.apidoc.model.ApiErrorDocModel

ApiErrorDocModel(Integer, String) - Constructor for class com.apporiented.rest.apidoc.model.ApiErrorDocModel

ApiErrorsDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used on your method and represents the possible errors returned by the method

ApiFieldDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used on your objects' fields and represents a field of an object

ApiHeaderDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used inside an annotations of type ApiHeadersDoc

ApiHeaderDocModel - Class in com.apporiented.rest.apidoc.model

Model of an API request header documentation.

ApiHeaderDocModel() - Constructor for class com.apporiented.rest.apidoc.model.ApiHeaderDocModel

ApiHeaderDocModel(String, String) - Constructor for class com.apporiented.rest.apidoc.model.ApiHeaderDocModel

ApiHeadersDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used on your method and contains an array of ApiHeader.

ApiMethodDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used on your exposed methods.

ApiMethodDocModel - Class in com.apporiented.rest.apidoc.model

Model of a REST resource method documentation.

ApiMethodDocModel() - Constructor for class com.apporiented.rest.apidoc.model.ApiMethodDocModel

ApiModelDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used on your object classes and represents an object used for communication between clients and server

ApiModelDocModel - Class in com.apporiented.rest.apidoc.model

Representation of the documentation of a model (domain) class.

ApiModelDocModel() - Constructor for class com.apporiented.rest.apidoc.model.ApiModelDocModel

ApiModelDocModel(String, String, List<ApiModelFieldDocModel>) - Constructor for class com.apporiented.rest.apidoc.model.ApiModelDocModel

ApiModelFieldDocModel - Class in com.apporiented.rest.apidoc.model

Model of the documentation of a DTO field.

ApiModelFieldDocModel() - Constructor for class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

ApiParamDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used inside an annotations of type ApiParams

ApiParamDocModel - Class in com.apporiented.rest.apidoc.model

ApiParamDocModel() - Constructor for class com.apporiented.rest.apidoc.model.ApiParamDocModel

ApiParamDocModel(String, String, ApiParamType, boolean, String, String[], String) - Constructor for class com.apporiented.rest.apidoc.model.ApiParamDocModel

ApiParamType - Enum in com.apporiented.rest.apidoc.utils

ApiResponseObjectDoc - Annotation Type in com.apporiented.rest.apidoc.annotation

This annotations is to be used on your method and represents the returned value

C

ClassInfo(Class<?>, String) - Constructor for class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory.ClassInfo

com.apporiented.rest.apidoc.annotation - package com.apporiented.rest.apidoc.annotation

com.apporiented.rest.apidoc.factory - package com.apporiented.rest.apidoc.factory

com.apporiented.rest.apidoc.model - package com.apporiented.rest.apidoc.model

com.apporiented.rest.apidoc.utils - package com.apporiented.rest.apidoc.utils

compareTo(ApiDocModel) - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

compareTo(ApiMethodDocModel) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

compareTo(ApiModelDocModel) - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

compareTo(ApiModelFieldDocModel) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

ControllerDocumentationFactory - Interface in com.apporiented.rest.apidoc.factory

Contract for factory implementations that provide a controller (REST resource) documentation.

createApiDocModel(Class<?>) - Method in interface com.apporiented.rest.apidoc.factory.ControllerDocumentationFactory

createApiDocModel(Class<?>) - Method in class com.apporiented.rest.apidoc.factory.SpringControllerDocumentationModel

createApiParamDocs(Method) - Method in class com.apporiented.rest.apidoc.factory.SpringControllerDocumentationModel

createDocumentation(String, String, ClassLoader...) - Method in class com.apporiented.rest.apidoc.factory.DefaultDocumentationFactory

createDocumentation(String, String, Class<?>...) - Method in class com.apporiented.rest.apidoc.factory.DefaultDocumentationFactory

createDocumentation(String, String, String...) - Method in class com.apporiented.rest.apidoc.factory.DefaultDocumentationFactory

createDocumentation(String, String, ClassLoader...) - Method in interface com.apporiented.rest.apidoc.factory.DocumentationFactory

createDocumentation(String, String, Class<?>...) - Method in interface com.apporiented.rest.apidoc.factory.DocumentationFactory

createDocumentation(String, String, String...) - Method in interface com.apporiented.rest.apidoc.factory.DocumentationFactory

createModelDocModel(Class) - Method in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

createModelDocModel(Class<?>) - Method in interface com.apporiented.rest.apidoc.factory.ModelDocumentationFactory

createModelRef(Class<?>, Type) - Method in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

createModelRef(Class<?>, Type) - Method in interface com.apporiented.rest.apidoc.factory.ModelDocumentationFactory

createModelReferenceId(Class<?>) - Method in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

D

DEFAULT_NAME - Static variable in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

DefaultDocumentationFactory - Class in com.apporiented.rest.apidoc.factory

Factory implementation for creating the API documentation.

DefaultDocumentationFactory() - Constructor for class com.apporiented.rest.apidoc.factory.DefaultDocumentationFactory

DefaultDocumentationFactory(ControllerDocumentationFactory, ModelDocumentationFactory) - Constructor for class com.apporiented.rest.apidoc.factory.DefaultDocumentationFactory

DEPRECATED - Static variable in class com.apporiented.rest.apidoc.utils.ApiDocConstants

Documentation - Class in com.apporiented.rest.apidoc.model

Model of the documentation of the complete REST API including used data transfer objects.

Documentation() - Constructor for class com.apporiented.rest.apidoc.model.Documentation

Documentation(String, String) - Constructor for class com.apporiented.rest.apidoc.model.Documentation

DocumentationFactory - Interface in com.apporiented.rest.apidoc.factory

Contract for factory implementations that provide a controller (REST resource) documentation.

G

getAction() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getAllowedValues() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getAllowedValues() - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

getApiErrors() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getApis() - Method in class com.apporiented.rest.apidoc.model.ApiDocModels

getApis() - Method in class com.apporiented.rest.apidoc.model.Documentation

getBasePath() - Method in class com.apporiented.rest.apidoc.model.Documentation

getBodyObject() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getClassName() - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

getClassName() - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

getClazz() - Method in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory.ClassInfo

getCode() - Method in class com.apporiented.rest.apidoc.model.ApiErrorDocModel

getConsumes() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getDataType() - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

getDescription() - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

getDescription() - Method in class com.apporiented.rest.apidoc.model.ApiErrorDocModel

getDescription() - Method in class com.apporiented.rest.apidoc.model.ApiHeaderDocModel

getDescription() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getDescription() - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

getDescription() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getDescription() - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

getDtos() - Method in class com.apporiented.rest.apidoc.model.Documentation

getFields() - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

getFormat() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getFormat() - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

getHeaders() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getHint() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getMap() - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

getMap() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getMapKeyObject() - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

getMapKeyObject() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getMapValueObject() - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

getMapValueObject() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getMethodName() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getMethods() - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

getModelClass() - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

getModelClasses() - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

getModelClasses() - Method in class com.apporiented.rest.apidoc.model.ApiDocModels

getModelRef() - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

getModelRef() - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

getMultiple() - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

getMultiple() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getName() - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

getName() - Method in class com.apporiented.rest.apidoc.model.ApiHeaderDocModel

getName() - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

getName() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getName() - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

getParameters() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getParamType() - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

getPath() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getProduces() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getRefKey() - Method in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory.ClassInfo

getRequired() - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

getResponse() - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

getType() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

getVersion() - Method in class com.apporiented.rest.apidoc.model.Documentation

getXmlNodeType() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

I

isRequired() - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

J

JAXBModelDocFactory - Class in com.apporiented.rest.apidoc.factory

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

JAXBModelDocFactory() - Constructor for class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

JAXBModelDocFactory.ClassInfo - Class in com.apporiented.rest.apidoc.factory

M

ModelDocumentationFactory - Interface in com.apporiented.rest.apidoc.factory

Contract for documentation factory that create a documentation for model classes used by the API.

S

setAction(String) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setAllowedValues(String[]) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setAllowedValues(String[]) - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

setApiErrors(List<ApiErrorDocModel>) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setApis(List<ApiDocModel>) - Method in class com.apporiented.rest.apidoc.model.Documentation

setBasePath(String) - Method in class com.apporiented.rest.apidoc.model.Documentation

setBodyObject(ApiDocModelRef) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setClassName(String) - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

setClassName(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

setCode(Integer) - Method in class com.apporiented.rest.apidoc.model.ApiErrorDocModel

setConsumes(List<String>) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setDataType(String) - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

setDescription(String) - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

setDescription(String) - Method in class com.apporiented.rest.apidoc.model.ApiErrorDocModel

setDescription(String) - Method in class com.apporiented.rest.apidoc.model.ApiHeaderDocModel

setDescription(String) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setDescription(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

setDescription(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setDescription(String) - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

setDtos(List<ApiModelDocModel>) - Method in class com.apporiented.rest.apidoc.model.Documentation

setFields(List<ApiModelFieldDocModel>) - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

setFormat(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setFormat(String) - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

setHeaders(List<ApiHeaderDocModel>) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setHint(String) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setMap(Boolean) - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

setMap(Boolean) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setMapKeyObject(String) - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

setMapKeyObject(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setMapValueObject(String) - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

setMapValueObject(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setMethodName(String) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setMethods(List<ApiMethodDocModel>) - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

setModelClass(Class<?>) - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

setModelClasses(Set<Class<?>>) - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

setModelRef(String) - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

setModelRef(String) - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

setMultiple(Boolean) - Method in class com.apporiented.rest.apidoc.model.ApiDocModelRef

setMultiple(Boolean) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setName(String) - Method in class com.apporiented.rest.apidoc.model.ApiDocModel

setName(String) - Method in class com.apporiented.rest.apidoc.model.ApiHeaderDocModel

setName(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelDocModel

setName(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setName(String) - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

setParameters(List<ApiParamDocModel>) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setParamType(ApiParamType) - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

setPath(String) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setProduces(List<String>) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setRequired(Boolean) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setRequired(Boolean) - Method in class com.apporiented.rest.apidoc.model.ApiParamDocModel

setResponse(ApiDocModelRef) - Method in class com.apporiented.rest.apidoc.model.ApiMethodDocModel

setType(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

setVersion(String) - Method in class com.apporiented.rest.apidoc.model.Documentation

setXmlNodeType(String) - Method in class com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

SpringControllerDocumentationModel - Class in com.apporiented.rest.apidoc.factory

Implementation of a factory that creates documentation for REST resources (controllers) based on internal annotations and Spring MVC annotations.

SpringControllerDocumentationModel(ModelDocumentationFactory) - Constructor for class com.apporiented.rest.apidoc.factory.SpringControllerDocumentationModel

U

UNDEFINED - Static variable in class com.apporiented.rest.apidoc.utils.ApiDocConstants

V

valueOf(String) - Static method in enum com.apporiented.rest.apidoc.utils.ApiParamType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.apporiented.rest.apidoc.utils.ApiParamType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WILDCARD - Static variable in class com.apporiented.rest.apidoc.utils.ApiDocConstants

X

XML_NODE_ATTR - Static variable in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

XML_NODE_ELEM - Static variable in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

XML_NODE_ELEM_WRAPPER - Static variable in class com.apporiented.rest.apidoc.factory.JAXBModelDocFactory

A C D G I J M S U V W X