com.mambu.apisdk.util

Enum ApiDefinition.ApiReturnFormat

java.lang.Object

java.lang.Enum<ApiDefinition.ApiReturnFormat>

com.mambu.apisdk.util.ApiDefinition.ApiReturnFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ApiDefinition.ApiReturnFormat>

Enclosing class:

ApiDefinition

public static enum ApiDefinition.ApiReturnFormat
extends java.lang.Enum<ApiDefinition.ApiReturnFormat>

ApiReturnFormat specifies if Mambu's returned JSON string represents a single object, a collection of objects or just a success/failure response

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN
COLLECTION
OBJECT
RESPONSE_STRING
ZIP_ARCHIVE

Method Summary

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

COLLECTION

public static final ApiDefinition.ApiReturnFormat COLLECTION

BOOLEAN

public static final ApiDefinition.ApiReturnFormat BOOLEAN

RESPONSE_STRING

public static final ApiDefinition.ApiReturnFormat RESPONSE_STRING

ZIP_ARCHIVE

public static final ApiDefinition.ApiReturnFormat ZIP_ARCHIVE

Method Detail

values

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

Returns:

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

valueOf

public static ApiDefinition.ApiReturnFormat valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null