Package com.nimbusds.common.ldap

Enum ResultFormat

java.lang.Object

java.lang.Enum<ResultFormat>

com.nimbusds.common.ldap.ResultFormat

All Implemented Interfaces:

Serializable, Comparable<ResultFormat>

public enum ResultFormat
extends Enum<ResultFormat>

Enumeration of LDAP response result formats.

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON	The result is formatted as JSON.
LDIF	The result is formatted as LDIF.

Method Summary

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

JSON

public static final ResultFormat JSON

The result is formatted as JSON.

LDIF

public static final ResultFormat LDIF

The result is formatted as LDIF.

Method Detail

values

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

Returns:

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

valueOf

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