|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<NameScope>
org.apache.commons.vfs2.NameScope
public enum NameScope
An enumerated type for file name scope, used when resolving a name relative to a file.
Enum Constant Summary | |
---|---|
CHILD
Resolve against the children of the base file. |
|
DESCENDENT
Resolve against the descendents of the base file. |
|
DESCENDENT_OR_SELF
Resolve against the descendents of the base file. |
|
FILE_SYSTEM
Resolve against files in the same file system as the base file. |
Method Summary | |
---|---|
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 |
---|
public static final NameScope CHILD
FILE_SYSTEM
. However, an exception is
thrown if the resolved file is not a direct child of the base file.
public static final NameScope DESCENDENT
FILE_SYSTEM
. However, an exception is thrown
if the resolved file is not a descendent of the base file.
public static final NameScope DESCENDENT_OR_SELF
FILE_SYSTEM
. However, an exception is thrown
if the resolved file is not a descendent of the base file, or the base
files itself.
public static final NameScope FILE_SYSTEM
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 |
---|
public static NameScope[] values()
for (NameScope c : NameScope.values()) System.out.println(c);
public static NameScope valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic String toString()
toString
in class Enum<NameScope>
public String getName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |