net.sf.mmm.util.file.api
Enum FileType

java.lang.Object
  java.lang.Enum<FileType>
      net.sf.mmm.util.file.api.FileType

All Implemented Interfaces:

Serializable, Comparable<FileType>

public enum FileType
extends Enum<FileType>

This enum contains the available types of a file.

Since:

1.0.1

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

DIRECTORY
represents a file

FILE
represents a plain file

Method Summary

static FileType	getType(File file) This method determines the type of a file.
static FileType	valueOf(String name) Returns the enum constant of this type with the specified name.
static FileType[]	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

DIRECTORY

public static final FileType DIRECTORY

represents a file

FILE

public static final FileType FILE

represents a plain file

Method Detail

values

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

Returns:

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

valueOf

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

getType

public static FileType getType(File file)

This method determines the type of a file.

Parameters:

file - is the file to check.

Returns:

DIRECTORY if the given file is a directory, FILE for a plain file and null otherwise.