com.carma.swagger.doclet.parser

Enum ResponseMessageSortMode

java.lang.Object

java.lang.Enum<ResponseMessageSortMode>

com.carma.swagger.doclet.parser.ResponseMessageSortMode

All Implemented Interfaces:

Serializable, Comparable<ResponseMessageSortMode>

public enum ResponseMessageSortMode
extends Enum<ResponseMessageSortMode>

The ResponseMessageSortMode represents the sort mode for response messages

Version:

$Id$

Author:

conor.roche

Enum Constant Summary

Enum Constants

Enum Constant and Description
AS_APPEARS This is the default which means in the order they appear in the javadoc
CODE_ASC This means in ascending order of the HTTP status code so success codes would come before error codes, this is the default
CODE_DESC This means in descending order of the HTTP status code so error codes would come before success codes

Method Summary

Methods

Modifier and Type	Method and Description
static ResponseMessageSortMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResponseMessageSortMode[]	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

AS_APPEARS

public static final ResponseMessageSortMode AS_APPEARS

This is the default which means in the order they appear in the javadoc

CODE_ASC

public static final ResponseMessageSortMode CODE_ASC

This means in ascending order of the HTTP status code so success codes would come before error codes, this is the default

CODE_DESC

public static final ResponseMessageSortMode CODE_DESC

This means in descending order of the HTTP status code so error codes would come before success codes

Method Detail

values

public static ResponseMessageSortMode[] 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 (ResponseMessageSortMode c : ResponseMessageSortMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ResponseMessageSortMode 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