Package org.apache.commons.fileupload2.core

Enum DeferrableOutputStream.State

java.lang.Object

java.lang.Enum<DeferrableOutputStream.State>

org.apache.commons.fileupload2.core.DeferrableOutputStream.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DeferrableOutputStream.State>

Enclosing class:

DeferrableOutputStream

public static enum DeferrableOutputStream.State
extends java.lang.Enum<DeferrableOutputStream.State>

This enumeration represents the possible states of the DeferrableOutputStream.

Enum Constant Summary

Enum Constants

Enum Constant	Description
closed	The stream has been closed, and data can no longer be written.
initialized	The stream object has been created with a non-negative threshold, but so far no data has been written.
opened	The stream object has been created with a non-negative threshold, and some data has been written, but the threshold is not yet exceeded, and the data is still kept in memory.
persisted	Either of the following conditions is given: The stream object has been created with a threshold of -1, or the stream object has been created with a non-negative threshold, and some data has been written.

Method Summary

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

initialized

public static final DeferrableOutputStream.State initialized

The stream object has been created with a non-negative threshold, but so far no data has been written.

opened

public static final DeferrableOutputStream.State opened

The stream object has been created with a non-negative threshold, and some data has been written, but the threshold is not yet exceeded, and the data is still kept in memory.

persisted

public static final DeferrableOutputStream.State persisted

Either of the following conditions is given:

1. The stream object has been created with a threshold of -1, or
2. the stream object has been created with a non-negative threshold, and some data has been written. The number of bytes, that have been written, exceeds the configured threshold.

In either case, a temporary file has been created, and all data has been written to the temporary file, erasing all existing data from memory.

closed

public static final DeferrableOutputStream.State closed

The stream has been closed, and data can no longer be written. It is now valid to invoke DeferrableOutputStream.getInputStream().

Method Detail

values

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

Returns:

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

valueOf

public static DeferrableOutputStream.State 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