com.unboundid.ldap.sdk.unboundidds.extensions

Enum CollectSupportDataOutputStream

java.lang.Object

java.lang.Enum<CollectSupportDataOutputStream>

com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataOutputStream

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CollectSupportDataOutputStream>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum CollectSupportDataOutputStream
extends java.lang.Enum<CollectSupportDataOutputStream>

This enum defines the output stream values that may be used in conjunction with the CollectSupportDataOutputIntermediateResponse.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

See Also:

CollectSupportDataExtendedRequest, CollectSupportDataOutputIntermediateResponse

Enum Constant Summary

Enum Constants

Enum Constant and Description
STANDARD_ERROR The output stream that will be used to indicate standard error.
STANDARD_OUTPUT The output stream that will be used to indicate standard output.

Method Summary

Modifier and Type	Method and Description
static CollectSupportDataOutputStream	forIntValue(int intValue) Retrieves the collect support data output stream value with the given integer value.
static CollectSupportDataOutputStream	forName(java.lang.String name) Retrieves the collect support data output stream value with the given name.
int	getIntValue() Retrieves the integer value for this collect support data output stream value.
java.lang.String	getName() Retrieves the name for this collect support data output stream value.
java.lang.String	toString() Retrieves a string representation of this collect support data output stream value.
static CollectSupportDataOutputStream	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CollectSupportDataOutputStream[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STANDARD_OUTPUT

public static final CollectSupportDataOutputStream STANDARD_OUTPUT

The output stream that will be used to indicate standard output.

STANDARD_ERROR

public static final CollectSupportDataOutputStream STANDARD_ERROR

The output stream that will be used to indicate standard error.

Method Detail

values

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

Returns:

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

valueOf

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

getName

@NotNull
public java.lang.String getName()

Retrieves the name for this collect support data output stream value.

Returns:

The name for this collect support data output stream value.

getIntValue

public int getIntValue()

Retrieves the integer value for this collect support data output stream value.

Returns:

The integer value for this collect support data output stream value.

forName

@Nullable
public static CollectSupportDataOutputStream forName(@NotNull
                                                               java.lang.String name)

Retrieves the collect support data output stream value with the given name.

Parameters:

name - The name for the output stream value to retrieve. It must not be null.

Returns:

The collect support data output stream value with the given name, or null if no output stream value is defined with the given name.

forIntValue

@Nullable
public static CollectSupportDataOutputStream forIntValue(int intValue)

Retrieves the collect support data output stream value with the given integer value.

Parameters:

intValue - The integer value for the output stream value to retrieve. It must not be null.

Returns:

The collect support data output stream value with the given integer value, or null if no output stream value is defined with the given integer value.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this collect support data output stream value.

Overrides:

toString in class java.lang.Enum<CollectSupportDataOutputStream>

Returns:

A string representation of this collect support data output stream value.