EntryName (TrueZIP Kernel 7.1.3 API)

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

All Implemented Interfaces:: Serializable, Comparable<EntryName>

Direct Known Subclasses:: FsEntryName

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

Addresses an entry in an entry container. Although this class is declared to be immutable, it's not declared to be final solely for the purpose of adding more constraints in subclass constructors so that their instances can be safely used as polymorphic instances of this class.

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.

Examples

Examples for valid entry name URIs are:

`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`
`../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

Identities

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

Serialization

This class supports serialization with both ObjectOutputStream and XMLEncoder.

Author:: Christian Schlichtherle
See Also:: Entry.getName(), Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SEPARATOR` The separator string for file names in an entry name, which is "/".
`static char`	`SEPARATOR_CHAR` The separator character for file names in an entry name, which is 47.
`private static long`	`serialVersionUID`
`private URI`	`uri`

Constructor Summary

Constructors
Constructor and Description
`EntryName(EntryName parent, EntryName member)` Constructs a new entry name by resolving the given member entry name against the given parent entry name.
`EntryName(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.
`EntryName(URI uri)` Constructs a new entry name by parsing the given URI.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(EntryName that)` Implements a natural ordering which is consistent with `equals(Object)`.
`static EntryName`	`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 EntryName`	`create(URI uri)` Constructs a new entry name by parsing the given URI.
`boolean`	`equals(Object that)` Returns `true` iff the given object is a entry name and its URI `equals` the URI of this entry name.
`String`	`getFragment()` Returns the fragment of this entry name.
`String`	`getPath()` Returns the path of this entry name.
`String`	`getQuery()` Returns the query of this entry name.
`URI`	`getUri()` Deprecated.
`int`	`hashCode()` Returns a hash code which is consistent with `equals(Object)`.
`private boolean`	`invariants()`
`private void`	`parse(URI uri)`
`private static String`	`quote(Object s)`
`private void`	`readObject(ObjectInputStream in)`
`String`	`toString()` Equivalent to calling `URI.toString()` on `toUri()`.
`URI`	`toUri()` Returns the URI for this entry name.
`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 string for file names in an entry 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 entry name, which is 47.
    
    See Also:
    SEPARATOR, Constant Field Values
  - uri
```
private URI uri
```
- Constructor Detail
  - EntryName
```
@Deprecated
public EntryName(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.
    
    Constructs a new entry name by calling new URI(uri) and parsing the resulting URI.
    
    Parameters:
    uri - the URI string representation.
    
    Throws:
    
    URISyntaxException - if uri does not conform to the syntax constraints for entry names.
  - EntryName
```
public EntryName(URI uri)
          throws URISyntaxException
```
    Constructs a new entry name by parsing the given URI.
    
    Parameters:
    uri - the URI.
    
    Throws:
    
    URISyntaxException - if uri does not conform to the syntax constraints for entry names.
  - EntryName
```
public EntryName(EntryName parent,
         EntryName member)
```
    Constructs a new entry name by resolving the given member entry name against the given parent entry name. Note that the URI of the parent entry name is considered to name a directory even if it's not ending with a SEPARATOR_CHAR, so calling this constructor with foo and bar as the URIs for the parent and member entry names will produce the URI foo/bar for the resulting entry name.
    
    Parameters:
    parent - an entry name for the parent.
    member - an entry name for the member.
- Method Detail
  - create
```
@Deprecated
public static EntryName 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.
    
    Constructs a new entry name by constructing a new URI from the given string representation and parsing the result. This static factory method calls new EntryName(uri) and wraps any thrown URISyntaxException in an IllegalArgumentException.
    
    Parameters:
    uri - the URI string representation.
    
    Returns:
    A new entry name.
    
    Throws:
    
    IllegalArgumentException - if uri does not conform to the syntax constraints for entry names.
  - create
```
public static EntryName create(URI uri)
```
    Constructs a new entry name by parsing the given URI. This static factory method calls new EntryName(uri) and wraps any thrown URISyntaxException in an IllegalArgumentException.
    
    Parameters:
    uri - the URI.
    
    Returns:
    A new entry name.
    
    Throws:
    
    IllegalArgumentException - if uri does not conform to the syntax constraints for entry names.
  - 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)
            throws URISyntaxException
```
    Throws:
    
    URISyntaxException
  - quote
```
private static String quote(Object s)
```
  - invariants
```
private boolean invariants()
```
  - toUri
```
public final URI toUri()
```
    Returns the URI for this entry name.
    
    Returns:
    The URI for this entry name.
    Since:
    
    TrueZIP 7.1.1
  - getUri
```
public final URI getUri()
```
    Deprecated.
    
    See Also:
    toUri()
  - getPath
```
public final String getPath()
```
    Returns the path of this entry name. Equivalent to toUri().getPath().
    
    Returns:
    The path of this entry name.
  - getQuery
```
@CheckForNull
public final String getQuery()
```
    Returns the query of this entry name. Equivalent to toUri().getQuery().
    
    Returns:
    The query of this entry name.
  - getFragment
```
@CheckForNull
public final String getFragment()
```
    Returns the fragment of this entry name. Equivalent to toUri().getFragment().
    
    Returns:
    The fragment of this entry name.
  - equals
```
public final boolean equals(@CheckForNull
             Object that)
```
    Returns true iff the given object is a entry name and its URI equals the URI of this entry name.
    
    Overrides:
    
    equals in class Object
  - compareTo
```
public final int compareTo(EntryName that)
```
    Implements a natural ordering which is consistent with equals(Object).
    
    Specified by:
    
    compareTo in interface Comparable<EntryName>
  - hashCode
```
public final int hashCode()
```
    Returns a hash code which is consistent with equals(Object).
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public final String toString()
```
    Equivalent to calling URI.toString() on toUri().
    
    Overrides:
    
    toString in class Object

Class EntryName

Specification

Examples

Identities

Serialization

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

SEPARATOR

SEPARATOR_CHAR

uri

Constructor Detail

EntryName

EntryName

EntryName

Method Detail

create

create

writeObject

readObject

parse

quote

invariants

toUri

getUri

getPath

getQuery

getFragment

equals

compareTo

hashCode

toString