com.alee.extended.tree
Enum FileTreeRootType

java.lang.Object
  java.lang.Enum<FileTreeRootType>
      com.alee.extended.tree.FileTreeRootType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileTreeRootType>

public enum FileTreeRootType
extends java.lang.Enum<FileTreeRootType>

This enumeration represents possible file tree root types. Also this enumeration provides root files for each of the listed root types.

Author:

Mikle Garin

Enum Constant Summary

drives
System hard drives as roots.

system
Root offered by underlying operating system.

userHome
User home folder as root.

Method Summary

abstract java.util.List<java.io.File>	getRoots() Returns root files for current tree root type.
static FileTreeRootType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FileTreeRootType[]	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

system

public static final FileTreeRootType system

Root offered by underlying operating system.

drives

public static final FileTreeRootType drives

System hard drives as roots.

userHome

public static final FileTreeRootType userHome

User home folder as root.

Method Detail

values

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

Returns:

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

valueOf

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

getRoots

public abstract java.util.List<java.io.File> getRoots()

Returns root files for current tree root type.

Returns:

root files for current tree root type