com.github.robtimus.io.stream

Enum LimitExceededStrategy

java.lang.Object

java.lang.Enum<LimitExceededStrategy>

com.github.robtimus.io.stream.LimitExceededStrategy

All Implemented Interfaces:

Serializable, Comparable<LimitExceededStrategy>

public enum LimitExceededStrategy
extends Enum<LimitExceededStrategy>

The possible strategies that can be used by LimitReader, LimitWriter, LimitInputStream and LimitOutputStream.

Author:

Rob Spoor

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCARD Indicates that any remaining content should be discarded.
THROW Indicates that a LimitExceededException should be thrown.

Method Summary

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

DISCARD

public static final LimitExceededStrategy DISCARD

Indicates that any remaining content should be discarded. For LimitReader and LimitInputStream this will effectively mean the stream will end.

THROW

public static final LimitExceededStrategy THROW

Indicates that a LimitExceededException should be thrown.

Method Detail

values

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

Returns:

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

valueOf

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