FsMountPoint (TrueZIP Kernel 7.1.3 API)

java.lang.Object
- de.schlichtherle.truezip.fs.FsMountPoint

All Implemented Interfaces:: Serializable, Comparable<FsMountPoint>

@Immutable
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public final class FsMountPoint
extends Object
implements Serializable, Comparable<FsMountPoint>

Addresses the mount point of a file system.

Specification

A mount point adds the following syntax constraints to a Uniform Resource Identifier:

The URI must be absolute, i.e. it must have a scheme component.
The URI must not have a query component.
The URI must not have a fragment component.
If the URI is opaque, its scheme specific part must end with the mount point separator "!/". The scheme specific part before the mount point separator is parsed according the syntax constraints for a FsPath and the following additional syntax constraints: The path component must be absolute. If its opaque, it's entry name must not be empty. Finally, its set as the value of the path component property.
Otherwise, if the URI is hierarchical, its path component must be in normal form and end with a "/". The path component property of the mount point is set to null in this case.

Examples

Examples for valid mount point URIs are:

`uri` property	`scheme` property	`path` URI	`parent` URI
`foo:/bar/`	`foo`	(n/a)^*	(n/a)^*
`foo:bar:/baz!/`	`foo`	`bar:/baz`	`bar:/`
`foo:bar:baz:/bang!/boom!/`	`foo`	`bar:baz:/bang!/boom`	`baz:/bang`

^* the component property is null and hence its URI is not available.

Examples for invalid mount point URIs are:

URI	Issue
`/foo`	not an absolute URI
`foo:/bar`	missing slash at end of hierarchical URI
`foo:/bar/#baz`	fragment component defined
`foo:bar:/baz!/bang`	missing mount point separator `"!/"` at end
`foo:bar:baz:/bang!/!/`	empty entry name in path component after mount point `"bar:baz:/bang!/"`

Identities

For any mount point m, it's generally true that new FsMountPoint(m.toUri()).equals(m).

For any mount point m with an opaque URI, it's generally true that new FsMountPoint(m.getScheme(), m.getPath()).equals(m).

Serialization

This class supports serialization with both ObjectOutputStream and XMLEncoder.

Author:: Christian Schlichtherle
See Also:: FsPath, FsEntryName, FsScheme, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private URI`	`hierarchical`
`private FsPath`	`path`
`private FsScheme`	`scheme`
`static String`	`SEPARATOR` The separator which is used to split opaque path names into `mount points` and `entry names`.
`private static long`	`serialVersionUID`
`private URI`	`uri`

Constructor Summary

Constructors
Constructor and Description
`FsMountPoint(FsScheme scheme, FsPath path)` Constructs a new opaque mount point by composing its URI from the given scheme and path.
`FsMountPoint(String uri)` Deprecated. This constructor does not quote characters with a special meaning in a URI - use the constructor variant with the URI parameter instead.
`FsMountPoint(String uri, FsUriModifier modifier)` Deprecated. This constructor does not quote characters with a special meaning in a URI - use the constructor variant with the URI parameter instead.
`FsMountPoint(URI uri)` Equivalent to `new FsMountPoint(uri, FsUriModifier.NULL)`.
`FsMountPoint(URI uri, FsUriModifier modifier)` Constructs a new mount point by parsing the given URI.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(FsMountPoint that)` Implements a natural ordering which is consistent with `equals(Object)`.
`static FsMountPoint`	`create(FsScheme scheme, FsPath path)` Constructs a new mount point by composing its URI from the given scheme and path.
`static FsMountPoint`	`create(String uri)` Deprecated. This method does not quote characters with a special meaning in a URI - use the method variant with the URI parameter instead.
`static FsMountPoint`	`create(String uri, FsUriModifier modifier)` Deprecated. This method does not quote characters with a special meaning in a URI - use the method variant with the URI parameter instead.
`static FsMountPoint`	`create(URI uri)` Equivalent to `create(uri, FsUriModifier.NULL)`.
`static FsMountPoint`	`create(URI uri, FsUriModifier modifier)` Constructs a new mount point by parsing the given URI.
`boolean`	`equals(Object that)` Returns `true` iff the given object is a mount point and its URI `equals` the URI of this mount point.
`URI`	`getHierarchicalUri()` Deprecated.
`FsMountPoint`	`getParent()` Returns the parent component, i.e. the mount point of the parent file system, or `null` iff this mount point's `URI` doesn't name a parent mount point, i.e. if and only if it's hierarchical.
`FsPath`	`getPath()` Returns the path component or `null` iff this mount point's `URI` doesn't name a parent mount point, i.e. if and only if it's hierarchical.
`FsScheme`	`getScheme()` Returns the scheme component.
`URI`	`getUri()` Deprecated.
`int`	`hashCode()` Returns a hash code which is consistent with `equals(Object)`.
`private boolean`	`invariants()`
`private void`	`parse(URI uri, FsUriModifier modifier)`
`private static String`	`quote(Object s)`
`private void`	`readObject(ObjectInputStream in)`
`FsPath`	`resolve(FsEntryName entryName)` Resolves the given entry name against this mount point.
`URI`	`toHierarchicalUri()` Returns a URI which is recursively transformed from the URI of this mount point so that it's absolute and hierarchical.
`String`	`toString()` Equivalent to calling `URI.toString()` on `toUri()`.
`URI`	`toUri()` Returns the URI for this mount point.
`private void`	`writeObject(ObjectOutputStream out)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - SEPARATOR
```
public static final String SEPARATOR
```
    The separator which is used to split opaque path names into mount points and entry names. This is identical to the separator in the class JarURLConnection.
    
    See Also:
    Constant Field Values
  - uri
```
private URI uri
```
  - path
```
@Nullable
private transient FsPath path
```
  - scheme
```
@Nullable
private transient volatile FsScheme scheme
```
  - hierarchical
```
@Nullable
private transient volatile URI hierarchical
```
- Constructor Detail
  - FsMountPoint
```
@Deprecated
public FsMountPoint(String uri)
             throws URISyntaxException
```
    Deprecated. This constructor does not quote characters with a special meaning in a URI - use the constructor variant with the URI parameter instead.
    
    Equivalent to new FsMountPoint(uri, FsUriModifier.NULL).
    
    Throws:
    
    URISyntaxException
  - FsMountPoint
```
@Deprecated
public FsMountPoint(String uri,
                       FsUriModifier modifier)
             throws URISyntaxException
```
    Deprecated. This constructor does not quote characters with a special meaning in a URI - use the constructor variant with the URI parameter instead.
    
    Constructs a new path by calling new URI(uri) and parsing the resulting URI.
    
    Parameters:
    uri - the URI string representation.
    modifier - the URI modifier.
    
    Throws:
    
    URISyntaxException - if uri does not conform to the syntax constraints for mount points.
  - FsMountPoint
```
public FsMountPoint(URI uri)
             throws URISyntaxException
```
    Equivalent to new FsMountPoint(uri, FsUriModifier.NULL).
    
    Throws:
    
    URISyntaxException
  - FsMountPoint
```
public FsMountPoint(URI uri,
            FsUriModifier modifier)
             throws URISyntaxException
```
    Constructs a new mount point by parsing the given URI.
    
    Parameters:
    uri - the URI.
    modifier - the URI modifier.
    
    Throws:
    
    URISyntaxException - if uri does not conform to the syntax constraints for mount points.
  - FsMountPoint
```
public FsMountPoint(FsScheme scheme,
            FsPath path)
             throws URISyntaxException
```
    Constructs a new opaque mount point by composing its URI from the given scheme and path.
    
    Parameters:
    scheme - the non-null scheme.
    path - the non-null path.
    
    Throws:
    
    URISyntaxException - if the composed mount point URI would not conform to the syntax constraints for mount points.
- Method Detail
  - create
```
@Deprecated
public static FsMountPoint create(String uri)
```
    Deprecated. This method does not quote characters with a special meaning in a URI - use the method variant with the URI parameter instead.
    
    Equivalent to create(uri, FsUriModifier.NULL).
  - create
```
@Deprecated
public static FsMountPoint create(String uri,
                             FsUriModifier modifier)
```
    Deprecated. This method does not quote characters with a special meaning in a URI - use the method variant with the URI parameter instead.
    
    Constructs a new mount point by constructing a new URI from the given string representation and parsing the result. This static factory method calls new FsMountPoint(uri, modifier) and wraps any thrown URISyntaxException in an IllegalArgumentException.
    
    Parameters:
    uri - the URI string representation.
    modifier - the URI modifier.
    
    Returns:
    A new mount point.
    
    Throws:
    
    IllegalArgumentException - if uri does not conform to the syntax constraints for mount points.
  - create
```
public static FsMountPoint create(URI uri)
```
    Equivalent to create(uri, FsUriModifier.NULL).
  - create
```
public static FsMountPoint create(URI uri,
                  FsUriModifier modifier)
```
    Constructs a new mount point by parsing the given URI. This static factory method calls new FsMountPoint(uri, modifier) and wraps any thrown URISyntaxException in an IllegalArgumentException.
    
    Parameters:
    uri - the URI.
    modifier - the URI modifier.
    
    Returns:
    A new mount point.
    
    Throws:
    
    IllegalArgumentException - if uri does not conform to the syntax constraints for mount points.
  - create
```
public static FsMountPoint create(FsScheme scheme,
                  FsPath path)
```
    Constructs a new mount point by composing its URI from the given scheme and path. This static factory method calls new FsMountPoint(scheme, path) and wraps any thrown URISyntaxException in an IllegalArgumentException.
    
    Parameters:
    scheme - the scheme.
    path - the path.
    
    Returns:
    A new mount point.
    
    Throws:
    
    IllegalArgumentException - if the composed mount point URI would not conform to the syntax constraints for mount points.
  - writeObject
```
private void writeObject(ObjectOutputStream out)
                  throws IOException
```
    Throws:
    
    IOException
  - readObject
```
private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
```
    Throws:
    
    IOException
    
    ClassNotFoundException
  - parse
```
private void parse(URI uri,
         FsUriModifier modifier)
            throws URISyntaxException
```
    Throws:
    
    URISyntaxException
  - quote
```
private static String quote(Object s)
```
  - invariants
```
private boolean invariants()
```
  - toUri
```
public URI toUri()
```
    Returns the URI for this mount point.
    
    Returns:
    The URI for this mount point.
    Since:
    
    TrueZIP 7.1.1
  - getUri
```
@Deprecated
public URI getUri()
```
    Deprecated.
    
    See Also:
    toUri()
  - toHierarchicalUri
```
public URI toHierarchicalUri()
```
    Returns a URI which is recursively transformed from the URI of this mount point so that it's absolute and hierarchical. If this mount point is already in hierarchical form, its URI is returned.
    For example, the mount point URIs zip:file:/archive!/ and tar:file:/archive!/ would both produce the hierarchical URI file:/archive.
    
    Returns:
    A URI which is recursively transformed from the URI of this mount point so that it's absolute and hierarchical.
    Since:
    
    TrueZIP 7.1.1
  - getHierarchicalUri
```
@Deprecated
public URI getHierarchicalUri()
```
    Deprecated.
    
    See Also:
    toHierarchicalUri()()
  - getScheme
```
public FsScheme getScheme()
```
    Returns the scheme component.
    
    Returns:
    The scheme component.
  - getPath
```
@Nullable
public FsPath getPath()
```
    Returns the path component or null iff this mount point's URI doesn't name a parent mount point, i.e. if and only if it's hierarchical.
    
    Returns:
    The nullable path component.
  - getParent
```
@Nullable
public FsMountPoint getParent()
```
    Returns the parent component, i.e. the mount point of the parent file system, or null iff this mount point's URI doesn't name a parent mount point, i.e. if and only if it's hierarchical.
    
    Returns:
    The nullable parent component.
  - resolve
```
public FsPath resolve(FsEntryName entryName)
```
    Resolves the given entry name against this mount point.
    
    Parameters:
    entryName - an entry name relative to this mount point.
    
    Returns:
    A new path with an absolute URI.
  - equals
```
public boolean equals(@CheckForNull
             Object that)
```
    Returns true iff the given object is a mount point and its URI equals the URI of this mount point. Note that this ignores the scheme and path.
    
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(FsMountPoint that)
```
    Implements a natural ordering which is consistent with equals(Object).
    
    Specified by:
    
    compareTo in interface Comparable<FsMountPoint>
  - hashCode
```
public int hashCode()
```
    Returns a hash code which is consistent with equals(Object).
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Equivalent to calling URI.toString() on toUri().
    
    Overrides:
    
    toString in class Object

Class FsMountPoint

Specification

Examples

Identities

Serialization

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

SEPARATOR

uri

path

scheme

hierarchical

Constructor Detail

FsMountPoint

FsMountPoint

FsMountPoint

FsMountPoint

FsMountPoint

Method Detail

create

create

create

create

create

writeObject

readObject

parse

quote

invariants

toUri

getUri

toHierarchicalUri

getHierarchicalUri

getScheme

getPath

getParent

resolve

equals

compareTo

hashCode

toString