org.projectodd.jrapidoc.annotation.rest

Annotation Type DocReturn

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface DocReturn

Annotatation can be used on resource methods for customizing return option in documentation.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	http Http status returned

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	cookies Http cookie names returned
String	description Description of return option
String[]	headers Http header names returned
DocReturn.Structure	structure Wrapper for type().
Class<?>	type Java type returned
String	typeDescription Description of returned type (set in type())

Element Detail

http

public abstract int http

Http status returned

Returns:

headers

public abstract String[] headers

Http header names returned

Returns:

Default:

{}

cookies

public abstract String[] cookies

Http cookie names returned

Returns:

Default:

{}

type

public abstract Class<?> type

Java type returned

Returns:

Default:

java.lang.Void.class

structure

public abstract DocReturn.Structure structure

Wrapper for type().

Returns:

Default:

org.projectodd.jrapidoc.annotation.rest.DocReturn.Structure.OBJECT

description

public abstract String description

Description of return option

Returns:

Default:

""

typeDescription

public abstract String typeDescription

Description of returned type (set in type())

Returns:

Default:

""