org.restdoc.server.impl

Class RestDocGeneratorExtensionAdapter

java.lang.Object

org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

All Implemented Interfaces:

IRestDocGeneratorExtension

Direct Known Subclasses:

OAuth2Extension

public class RestDocGeneratorExtensionAdapter
extends Object
implements IRestDocGeneratorExtension

Constructor Summary

Constructors

Constructor and Description
RestDocGeneratorExtensionAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	headerParam(String name, org.restdoc.api.HeaderDefinition definition, Type paramType, AnnotationMap map) invoked for every header parameter
void	newMethod(org.restdoc.api.RestResource restResource, org.restdoc.api.MethodDefinition def, Method method) invoked for every method
void	newResource(org.restdoc.api.RestResource restResource) invoked on every new rest resource
void	newSchema(String schemaURI, org.restdoc.api.Schema s, Class<?> schemaClass) invoked for every used schema class
void	pathParam(String name, org.restdoc.api.ParamDefinition definition, Type paramType, AnnotationMap map) invoked for every path parameter
void	queryParam(String name, org.restdoc.api.ParamDefinition definition, Type paramType, AnnotationMap map) invoked for every query parameter
void	renderDoc(String path, org.restdoc.api.RestDoc doc) invoked of RestDoc generation

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDocGeneratorExtensionAdapter

public RestDocGeneratorExtensionAdapter()

Method Detail

newResource

public void newResource(org.restdoc.api.RestResource restResource)

Description copied from interface: IRestDocGeneratorExtension

invoked on every new rest resource

Specified by:

newResource in interface IRestDocGeneratorExtension

Parameters:

restResource - the RestResource

queryParam

public void queryParam(String name,
              org.restdoc.api.ParamDefinition definition,
              Type paramType,
              AnnotationMap map)

Description copied from interface: IRestDocGeneratorExtension

invoked for every query parameter

Specified by:

queryParam in interface IRestDocGeneratorExtension

Parameters:

name - the parameter name

definition - the ParamDefinition

paramType - the Java class of the parameter

map - the map of annotations

pathParam

public void pathParam(String name,
             org.restdoc.api.ParamDefinition definition,
             Type paramType,
             AnnotationMap map)

Description copied from interface: IRestDocGeneratorExtension

invoked for every path parameter

Specified by:

pathParam in interface IRestDocGeneratorExtension

Parameters:

name - the parameter name

definition - the ParamDefinition

paramType - the Java class of the parameter

map - the map of annotations

headerParam

public void headerParam(String name,
               org.restdoc.api.HeaderDefinition definition,
               Type paramType,
               AnnotationMap map)

Description copied from interface: IRestDocGeneratorExtension

invoked for every header parameter

Specified by:

headerParam in interface IRestDocGeneratorExtension

Parameters:

name - the parameter name

definition - the HeaderDefinition

paramType - the Java class of the parameter

map - the map of annotations

newMethod

public void newMethod(org.restdoc.api.RestResource restResource,
             org.restdoc.api.MethodDefinition def,
             Method method)

Description copied from interface: IRestDocGeneratorExtension

invoked for every method

Specified by:

newMethod in interface IRestDocGeneratorExtension

Parameters:

restResource - the super resource

def - the MethodDefinition

method - the Java reflection Method

newSchema

public void newSchema(String schemaURI,
             org.restdoc.api.Schema s,
             Class<?> schemaClass)

Description copied from interface: IRestDocGeneratorExtension

invoked for every used schema class

Specified by:

newSchema in interface IRestDocGeneratorExtension

Parameters:

schemaURI - the schema URI

s - the Schema

schemaClass - the Java class

renderDoc

public void renderDoc(String path,
             org.restdoc.api.RestDoc doc)

Description copied from interface: IRestDocGeneratorExtension

invoked of RestDoc generation

Specified by:

renderDoc in interface IRestDocGeneratorExtension

Parameters:

path - the requested path

doc - the generated doc