net.java.truevfs.kernel.spec

Class FsNodeName

java.lang.Object

net.java.truevfs.kernel.spec.FsNodeName

All Implemented Interfaces:

Serializable, Comparable<FsNodeName>

@Immutable
public final class FsNodeName
extends Object
implements Serializable, Comparable<FsNodeName>

Addresses a file system node relative to its mount point.

Specification

An node name adds the following syntax constraints to a Uniform Resource Identifier:

1. The URI must be relative, that is it must not define a scheme component.
2. The URI must not define an authority component.
3. The URI must define a path component.
4. The URI's path must be in normal form, that is its path component must not contain redundant "." and ".." segments.
5. The URI's path component must not equal ".".
6. The URI's path component must not equal "..".
7. The URI's path component must not start with "/".
8. The URI's path component must not start with "./" (this rule is actually redundant - see #3).
9. The URI's path component must not start with "../".
10. The URI's path component must not end with "/".
11. The URI must not define a fragment component.

Examples

Examples for valid node name URIs:

uri property	root property	path property	query property
""	true	""	null
"foo"	false	"foo"	null
"foo/bar"	false	"foo/bar"	null
"foo?bar"	false	"foo"	"bar"

Examples for invalid node name URIs:

URI	Issue
foo:/bar	not a relative URI
//foo/bar	authority component defined
/foo	leading slash not allowed
foo/	trailing slash not allowed
foo/.	not a normalized URI
foo#bar	fragment defined

Identities

For any node name e, it's generally true that new FsNodeName(e.getUri()).equals(e).

Serialization

This class supports serialization with both ObjectOutputStream and XMLEncoder.

Author:

Christian Schlichtherle

See Also:

FsNodePath, FsMountPoint, FsScheme, FsNode.getName(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FsNodeName	ROOT The file system node name of the root directory, which is an empty URI.
static String	SEPARATOR The separator string for file names in an node name, which is "/".
static char	SEPARATOR_CHAR The separator character for file names in an node name, which is 47.

Constructor Summary

Constructors

Constructor and Description
FsNodeName(FsNodeName parent, FsNodeName member) Constructs a new file system node name by resolving the given member file system node name against the given parent file system node name.
FsNodeName(URI uri) Constructs a new file system node name by parsing the given URI.
FsNodeName(URI uri, FsUriModifier modifier) Constructs a new file system node name by parsing the given URI after applying the given URI modifier.

Method Summary

Modifier and Type	Method and Description
int	compareTo(FsNodeName that) Implements a natural ordering which is consistent with equals(Object).
static FsNodeName	create(URI uri) Constructs a new file system node name by parsing the given URI.
static FsNodeName	create(URI uri, FsUriModifier modifier) Constructs a new file system node name by parsing the given URI after applying the given URI modifier.
boolean	equals(Object that) Returns true iff the given object is a node name and its URI equals the URI of this node name.
String	getPath() Returns the path component of this node name.
String	getQuery() Returns the query component of this node name.
URI	getUri() Returns the URI for this node name.
int	hashCode() Returns a hash code which is consistent with equals(Object).
boolean	isRoot() Returns true if and only if the path component of this file system node name is empty and no query component is defined.
String	toString() Equivalent to calling URI.toString() on getUri().

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROOT

public static final FsNodeName ROOT

The file system node name of the root directory, which is an empty URI.

SEPARATOR

public static final String SEPARATOR

The separator string for file names in an node name, which is "/".

See Also:

SEPARATOR_CHAR, Constant Field Values

SEPARATOR_CHAR

public static final char SEPARATOR_CHAR

The separator character for file names in an node name, which is 47.

See Also:

SEPARATOR, Constant Field Values

Constructor Detail

FsNodeName

public FsNodeName(FsNodeName parent,
                  FsNodeName member)

Constructs a new file system node name by resolving the given member file system node name against the given parent file system node name. Note that the URI of the parent file system node name is always considered to name a directory, so calling this constructor with "foo" and "bar" as the URIs for the parent and member file system node names results in "foo/bar" as the file system node name URI.

Parameters:

parent - an node name for the parent.

member - an node name for the member.

FsNodeName

@ConstructorProperties(value="uri")
public FsNodeName(URI uri)
                                               throws URISyntaxException

Constructs a new file system node name by parsing the given URI.

Parameters:

uri - the URI.

Throws:

NullPointerException - if uri is null.

URISyntaxException - if uri does not conform to the syntax constraints for file system node names.

FsNodeName

public FsNodeName(URI uri,
                  FsUriModifier modifier)
           throws URISyntaxException

Constructs a new file system node name by parsing the given URI after applying the given URI modifier.

Parameters:

uri - the URI.

modifier - the URI modifier.

Throws:

NullPointerException - if uri or modifier are null.

URISyntaxException - if uri still does not conform to the syntax constraints for file system node names after its modification.

Method Detail

compareTo

public int compareTo(FsNodeName that)

Implements a natural ordering which is consistent with equals(Object).

Specified by:

compareTo in interface Comparable<FsNodeName>

Parameters:

that - the node name to compare.

create

public static FsNodeName create(URI uri)

Constructs a new file system node name by parsing the given URI. This static factory method calls new FsNodeName(uri, FsUriModifier.NULL) and wraps any thrown URISyntaxException in an IllegalArgumentException.

Parameters:

uri - the URI.

Returns:

A new file system node name.

Throws:

NullPointerException - if uri is null.

IllegalArgumentException - if uri does not conform to the syntax constraints for file system node names.

create

public static FsNodeName create(URI uri,
                                FsUriModifier modifier)

Constructs a new file system node name by parsing the given URI after applying the given URI modifier. This static factory method calls new FsNodeName(uri, modifier) and wraps any thrown URISyntaxException in an IllegalArgumentException.

Parameters:

uri - the URI.

modifier - the URI modifier.

Returns:

A new file system node name.

Throws:

NullPointerException - if uri or modifier are null.

IllegalArgumentException - if uri still does not conform to the syntax constraints for file system node names after its modification.

equals

public boolean equals(@CheckForNull
                      Object that)

Returns true iff the given object is a node name and its URI equals the URI of this node name.

Overrides:

equals in class Object

Parameters:

that - the object to compare.

getPath

public String getPath()

Returns the path component of this node name. Equivalent to getUri().getPath().

Returns:

The path component of this node name.

getQuery

@CheckForNull
public String getQuery()

Returns the query component of this node name. Equivalent to getUri().getQuery().

Returns:

The query component of this node name.

getUri

public URI getUri()

Returns the URI for this node name.

Returns:

The URI for this node name.

hashCode

public int hashCode()

Returns a hash code which is consistent with equals(Object).

Overrides:

hashCode in class Object

isRoot

public boolean isRoot()

Returns true if and only if the path component of this file system node name is empty and no query component is defined.

Returns:

true if and only if the path component of this file system node name is empty and no query component is defined.

toString

public String toString()

Equivalent to calling URI.toString() on getUri().

Overrides:

toString in class Object