net.java.truevfs.kernel.spec

Class FsScheme

java.lang.Object

net.java.truevfs.kernel.spec.FsScheme

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FsScheme>

@Immutable
public final class FsScheme
extends java.lang.Object
implements java.io.Serializable, java.lang.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.

See Also:

FsNodePath, FsMountPoint, FsNodeName, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FsScheme(java.lang.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(java.lang.String scheme) Constructs a new URI scheme by parsing the given string.
boolean	equals(java.lang.Object that)
java.lang.String	getScheme() Deprecated. This method is solely provided to support XMLEncoder/XMLDecoder. Applications should call toString() instead.
int	hashCode()
java.lang.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(java.lang.String scheme)
                                                throws java.net.URISyntaxException

Constructs a new URI scheme by parsing the given string.

Parameters:

scheme - the URI scheme.

Throws:

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

Method Detail

create

public static FsScheme create(java.lang.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:

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

getScheme

@Deprecated
public java.lang.String getScheme()

Deprecated. This method is solely provided to support XMLEncoder/XMLDecoder. Applications should call toString() instead.

Returns the scheme as a string.

Returns:

The scheme as a string.

Since:

TrueVFS 0.10

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(FsScheme that)

Specified by:

compareTo in interface java.lang.Comparable<FsScheme>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns the scheme as a string.

Overrides:

toString in class java.lang.Object

Returns:

The scheme as a string.