com.helger.commons.io.file

Enum EFileIOOperation

java.lang.Object

java.lang.Enum<EFileIOOperation>

com.helger.commons.io.file.EFileIOOperation

All Implemented Interfaces:

Serializable, Comparable<EFileIOOperation>

public enum EFileIOOperation
extends Enum<EFileIOOperation>

An enumeration that encapsulates all available file IO operation types.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
COPY_DIR_RECURSIVE
COPY_FILE
CREATE_DIR
CREATE_DIR_RECURSIVE
DELETE_DIR
DELETE_DIR_RECURSIVE
DELETE_FILE
RENAME_DIR
RENAME_FILE

Method Summary

Methods

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

COPY_DIR_RECURSIVE

public static final EFileIOOperation COPY_DIR_RECURSIVE

COPY_FILE

public static final EFileIOOperation COPY_FILE

CREATE_DIR

public static final EFileIOOperation CREATE_DIR

CREATE_DIR_RECURSIVE

public static final EFileIOOperation CREATE_DIR_RECURSIVE

DELETE_DIR

public static final EFileIOOperation DELETE_DIR

DELETE_DIR_RECURSIVE

public static final EFileIOOperation DELETE_DIR_RECURSIVE

DELETE_FILE

public static final EFileIOOperation DELETE_FILE

RENAME_DIR

public static final EFileIOOperation RENAME_DIR

RENAME_FILE

public static final EFileIOOperation RENAME_FILE

Method Detail

values

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

Returns:

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

valueOf

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

getParamCount

@Nonnegative
public int getParamCount()

Returns:

The number of parameters (File objects) involved in this operation. Always > 0.