FsEntryName (TrueZIP Kernel 7.1.3 API)

java.lang.Object
- de.schlichtherle.truezip.entry.EntryName
- - de.schlichtherle.truezip.fs.FsEntryName

All Implemented Interfaces:: Serializable, Comparable<EntryName>

@Immutable
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public final class FsEntryName
extends EntryName

Addresses an entry in a file system relative to its mount point.

Specification

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

The URI must be relative, i.e. it must not have a scheme component.
The URI must not have an authority component.
The URI must not have a fragment component.
The URI's path must be in normal form, i.e. its path component must not contain redundant "." and ".." segments.
The URI's path component must not equal ".".
The URI's path component must not equal "..".
The URI's path component must not start with "/".
The URI's path component must not start with "./" (this rule is actually redundant - see #3).
The URI's path component must not start with "../".
The URI's path component must not end with "/".

Examples

Examples for valid entry name URIs are:

"foo"
"foo/bar"

`uri` property	`path` property	`query` property	`fragment` property
`foo`	`foo`	(null)	(null)
`foo/bar`	`foo/bar`	(null)	(null)
`foo?bar`	`foo`	`bar`	(null)
`foo#bar`	`foo`	(null)	`bar`

Examples for invalid entry name URIs are:

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

Identities

For any entry name e, it's generally true that new FsEntryName(e.toUri()).equals(e).

Serialization

This class supports serialization with both ObjectOutputStream and XMLEncoder.

Author:: Christian Schlichtherle
See Also:: FsPath, FsMountPoint, FsScheme, FsEntry.getName(), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`ILLEGAL_PREFIX`
`static FsEntryName`	`ROOT` The file system entry name of the root directory, which is an empty URI.
`private static long`	`serialVersionUID`

Fields inherited from class de.schlichtherle.truezip.entry.EntryName
SEPARATOR, SEPARATOR_CHAR

Constructor Summary

Constructors
Constructor and Description
`FsEntryName(FsEntryName parent, FsEntryName member)` Constructs a new file system entry name by resolving the given member file system entry name against the given parent file system entry name.
`FsEntryName(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.
`FsEntryName(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.
`FsEntryName(URI uri)` Equivalent to `new FsEntryName(uri, FsUriModifier.NULL)`.
`FsEntryName(URI uri, FsUriModifier modifier)` Constructs a new file system entry name by parsing the given URI.

Method Summary

Methods
Modifier and Type	Method and Description
`static FsEntryName`	`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 FsEntryName`	`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 FsEntryName`	`create(URI uri)` Equivalent to `create(uri, FsUriModifier.NULL)`.
`static FsEntryName`	`create(URI uri, FsUriModifier modifier)` Constructs a new file system entry name by parsing the given URI.
`private boolean`	`invariants()`
`boolean`	`isRoot()`
`private void`	`parse(URI uri)`
`private static String`	`quote(Object s)`
`private void`	`readObject(ObjectInputStream in)`

Methods inherited from class de.schlichtherle.truezip.entry.EntryName
compareTo, equals, getFragment, getPath, getQuery, getUri, hashCode, toString, toUri

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
  - ILLEGAL_PREFIX
```
private static final String ILLEGAL_PREFIX
```
    See Also:
    Constant Field Values
  - ROOT
```
public static final FsEntryName ROOT
```
    The file system entry name of the root directory, which is an empty URI.
- Constructor Detail
  - FsEntryName
```
@Deprecated
public FsEntryName(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 FsEntryName(uri, FsUriModifier.NULL).
    
    Throws:
    
    URISyntaxException
  - FsEntryName
```
@Deprecated
public FsEntryName(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 file system entry name 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 entry names.
  - FsEntryName
```
public FsEntryName(URI uri)
            throws URISyntaxException
```
    Equivalent to new FsEntryName(uri, FsUriModifier.NULL).
    
    Throws:
    
    URISyntaxException
  - FsEntryName
```
public FsEntryName(URI uri,
           FsUriModifier modifier)
            throws URISyntaxException
```
    Constructs a new file system entry name by parsing the given URI.
    
    Parameters:
    uri - the URI.
    modifier - the URI modifier.
    
    Throws:
    
    NullPointerException - if uri is null.
    
    URISyntaxException - if uri does not conform to the syntax constraints for file system entry names.
  - FsEntryName
```
public FsEntryName(FsEntryName parent,
           FsEntryName member)
```
    Constructs a new file system entry name by resolving the given member file system entry name against the given parent file system entry name. Note that the URI of the parent file system entry 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 entry names results in "foo/bar" as the file system entry name URI.
    
    Parameters:
    parent - an entry name for the parent.
    member - an entry name for the member.
- Method Detail
  - create
```
@Deprecated
public static FsEntryName 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 FsEntryName 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 file system entry name by constructing a new URI from the given string representation and parsing the result. This static factory method calls new FsEntryName(uri, modifier) and wraps any thrown URISyntaxException in an IllegalArgumentException.
    
    Parameters:
    uri - the URI string representation.
    modifier - the URI modifier.
    
    Returns:
    A new file system entry name.
    
    Throws:
    
    IllegalArgumentException - if uri does not conform to the syntax constraints for entry names.
  - create
```
public static FsEntryName create(URI uri)
```
    Equivalent to create(uri, FsUriModifier.NULL).
  - create
```
public static FsEntryName create(URI uri,
                 FsUriModifier modifier)
```
    Constructs a new file system entry name by parsing the given URI. This static factory method calls new FsEntryName(uri, modifier) and wraps any thrown URISyntaxException in an IllegalArgumentException.
    
    Parameters:
    uri - the URI.
    modifier - the URI modifier.
    
    Returns:
    A new file system entry name.
    
    Throws:
    
    IllegalArgumentException - if uri does not conform to the syntax constraints for entry names.
  - readObject
```
private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
```
    Throws:
    
    IOException
    
    ClassNotFoundException
  - parse
```
private void parse(URI uri)
            throws URISyntaxException
```
    Throws:
    
    URISyntaxException
  - quote
```
private static String quote(Object s)
```
  - invariants
```
private boolean invariants()
```
  - isRoot
```
public boolean isRoot()
```

Class FsEntryName

Specification

Examples

Identities

Serialization

Field Summary

Fields inherited from class de.schlichtherle.truezip.entry.EntryName

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.entry.EntryName

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

ILLEGAL_PREFIX

ROOT

Constructor Detail

FsEntryName

FsEntryName

FsEntryName

FsEntryName

FsEntryName

Method Detail

create

create

create

create

readObject

parse

quote

invariants

isRoot