1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.commons.vfs;
18
19 /***
20 * An enumerated type for file name scope, used when resolving a name relative
21 * to a file.
22 *
23 * @author <a href="mailto:adammurdoch@apache.org">Adam Murdoch</a>
24 * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
25 */
26 public final class NameScope
27 {
28 /***
29 * Resolve against the children of the base file. The name is resolved
30 * as described by {@link #FILE_SYSTEM}. However, an exception is
31 * thrown if the resolved file is not a direct child of the base file.
32 */
33 public static final NameScope CHILD = new NameScope("child");
34
35 /***
36 * Resolve against the descendents of the base file. The name is resolved
37 * as described by {@link #FILE_SYSTEM}. However, an exception is thrown
38 * if the resolved file is not a descendent of the base file.
39 */
40 public static final NameScope DESCENDENT = new NameScope("descendent");
41
42 /***
43 * Resolve against the descendents of the base file. The name is resolved
44 * as described by {@link #FILE_SYSTEM}. However, an exception is thrown
45 * if the resolved file is not a descendent of the base file, or the base
46 * files itself.
47 */
48 public static final NameScope DESCENDENT_OR_SELF =
49 new NameScope("descendent_or_self");
50
51 /***
52 * Resolve against files in the same file system as the base file.
53 * <p/>
54 * <p>If the supplied name is an absolute path, then it is resolved
55 * relative to the root of the file system that the base file belongs to.
56 * If a relative name is supplied, then it is resolved relative to the base
57 * file.
58 * <p/>
59 * <p>The path may use any mix of <code>/</code>, <code>\</code>, or file
60 * system specific separators to separate elements in the path. It may
61 * also contain <code>.</code> and <code>..</code> elements.
62 * <p/>
63 * <p>A path is considered absolute if it starts with a separator character,
64 * and relative if it does not.
65 */
66 public static final NameScope FILE_SYSTEM = new NameScope("filesystem");
67
68 private final String name;
69
70 private NameScope(final String name)
71 {
72 this.name = name;
73 }
74
75 /***
76 * Returns the name of the scope.
77 */
78 public String toString()
79 {
80 return name;
81 }
82
83 /***
84 * Returns the name of the scope.
85 */
86 public String getName()
87 {
88 return name;
89 }
90 }