org.apache.commons.vfs2

Enum NameScope

java.lang.Object

java.lang.Enum<NameScope>

org.apache.commons.vfs2.NameScope

All Implemented Interfaces:

Serializable, Comparable<NameScope>

public enum NameScope
extends Enum<NameScope>

An enumerated type for file name scope, used when resolving a name relative to a file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILD Resolve against the children of the base file.
DESCENDENT Resolve against the descendants of the base file.
DESCENDENT_OR_SELF Resolve against the descendants of the base file.
FILE_SYSTEM Resolve against files in the same file system as the base file.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHILD

public static final NameScope CHILD

Resolve against the children of the base file. The name is resolved as described by FILE_SYSTEM. However, an exception is thrown if the resolved file is not a direct child of the base file.

DESCENDENT

public static final NameScope DESCENDENT

Resolve against the descendants of the base file. The name is resolved as described by FILE_SYSTEM. However, an exception is thrown if the resolved file is not a descendent of the base file.

DESCENDENT_OR_SELF

public static final NameScope DESCENDENT_OR_SELF

Resolve against the descendants of the base file. The name is resolved as described by FILE_SYSTEM. However, an exception is thrown if the resolved file is not a descendent of the base file, or the base files itself.

FILE_SYSTEM

public static final NameScope FILE_SYSTEM

Resolve against files in the same file system as the base file.

If the supplied name is an absolute path, then it is resolved relative to the root of the file system that the base file belongs to. If a relative name is supplied, then it is resolved relative to the base file.

The path may use any mix of /, \, or file system specific separators to separate elements in the path. It may also contain . and .. elements.

A path is considered absolute if it starts with a separator character, and relative if it does not.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns the name of the scope.

Overrides:

toString in class Enum<NameScope>

Returns:

The name of the scope.

getName

public String getName()

Returns the name of the scope.

Returns:

The name of the scope.