net.java.truevfs.kernel.spec

Class FsScheme

java.lang.Object

net.java.truevfs.kernel.spec.FsScheme

All Implemented Interfaces:

Serializable, Comparable<FsScheme>

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

Addresses a file system scheme. This is simply a URI scheme according to the syntax constraints defined in RFC 2396: Uniform Resource Identifiers (URI): Generic Syntax.

Serialization

This class supports serialization with both ObjectOutputStream and XMLEncoder.

Author:

Christian Schlichtherle

See Also:

FsNodePath, FsMountPoint, FsNodeName, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FsScheme(String scheme) Constructs a new URI scheme by parsing the given string.

Method Summary

Modifier and Type	Method and Description
int	compareTo(FsScheme that)
static FsScheme	create(String scheme) Constructs a new URI scheme by parsing the given string.
boolean	equals(Object that)
int	hashCode()
String	toString() Returns the scheme as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

FsScheme

@ConstructorProperties(value="scheme")
public FsScheme(String scheme)
                                                throws URISyntaxException

Constructs a new URI scheme by parsing the given string.

Parameters:

scheme - the URI scheme.

Throws:

URISyntaxException - if scheme does not conform to the syntax constraints for URI schemes.

Method Detail

compareTo

public int compareTo(FsScheme that)

Specified by:

compareTo in interface Comparable<FsScheme>

create

public static FsScheme create(String scheme)

Constructs a new URI scheme by parsing the given string. This static factory method calls new FsScheme(scheme) and wraps any thrown URISyntaxException in an IllegalArgumentException.

Parameters:

scheme - the URI scheme.

Returns:

A new scheme.

Throws:

IllegalArgumentException - if scheme does not conform to the syntax constraints for URI schemes.

equals

public boolean equals(Object that)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns the scheme as a string.

Overrides:

toString in class Object

Returns:

The scheme as a string.