org.projectodd.jrapidoc.annotation.rest

Enum DocReturn.Structure

java.lang.Object

java.lang.Enum<DocReturn.Structure>

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

All Implemented Interfaces:

Serializable, Comparable<DocReturn.Structure>

Enclosing class:

DocReturn

public static enum DocReturn.Structure
extends Enum<DocReturn.Structure>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY DocReturn.type() is wrapped into array
MAP DocReturn.type() is wrapped into map as value type (key type is string)
OBJECT DocReturn.type() is not wrapped

Method Summary

Methods

Modifier and Type	Method and Description
static DocReturn.Structure	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocReturn.Structure[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OBJECT

public static final DocReturn.Structure OBJECT

DocReturn.type() is not wrapped

ARRAY

public static final DocReturn.Structure ARRAY

DocReturn.type() is wrapped into array

MAP

public static final DocReturn.Structure MAP

DocReturn.type() is wrapped into map as value type (key type is string)

Method Detail

values

public static DocReturn.Structure[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DocReturn.Structure c : DocReturn.Structure.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocReturn.Structure valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null