net.sf.mmm.util.io.api

Enum IoMode

java.lang.Object

java.lang.Enum<IoMode>

net.sf.mmm.util.io.api.IoMode

All Implemented Interfaces:

Serializable, Comparable<IoMode>

public enum IoMode
extends Enum<IoMode>

This enum holds the possible modes of I/O.

Since:

2.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE Indicates that a handle is closed.
COPY Indicates that data is copied.
FLUSH Indicates that a handle is flushed.
OPEN Indicates that a handle is opened.
READ Indicates that data is read from a source.
WRITE Indicates that data is written to a target.

Method Summary

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

READ

public static final IoMode READ

Indicates that data is read from a source.

WRITE

public static final IoMode WRITE

Indicates that data is written to a target.

CLOSE

public static final IoMode CLOSE

Indicates that a handle is closed.

FLUSH

public static final IoMode FLUSH

Indicates that a handle is flushed.

COPY

public static final IoMode COPY

Indicates that data is copied.

OPEN

public static final IoMode OPEN

Indicates that a handle is opened.

Method Detail

values

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

Returns:

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

valueOf

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