de.schlichtherle.truezip.entry

Class EntryName

java.lang.Object

de.schlichtherle.truezip.entry.EntryName

All Implemented Interfaces:

Serializable, Comparable<EntryName>

Direct Known Subclasses:

FsEntryName

@Immutable
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:

1. The URI must be relative, that is it must not define a scheme component.
2. The URI must not define an authority component.
3. The URI must define a path component.
4. The URI must not define a fragment component.

Examples

Examples for valid entry name URIs are:

uri property	path property	query property
foo	foo	(null)
foo/bar	foo/bar	(null)
foo?bar	foo	bar
../foo/./	../foo/./	(null)

Examples for invalid entry name URIs are:

URI	Issue
foo:/bar	scheme component defined
//foo/bar	authority component defined
foo#bar	fragment 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.

TODO: This class is solely used for extension by the class de.schlichtherle.truezip.fs.FsEntryName and should be removed in TrueZIP 8.

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.

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(URI uri) Constructs a new entry name by parsing the given URI.

Method Summary

Modifier and Type	Method and Description
int	compareTo(EntryName that) Implements a natural ordering which is consistent with equals(Object).
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.
int	hashCode() Returns a hash code which is consistent with equals(Object).
String	toString() Equivalent to calling URI.toString() on toUri().
URI	toUri() Returns the URI for this entry name.

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

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.

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.

Method Detail

compareTo

public final int compareTo(EntryName that)

Implements a natural ordering which is consistent with equals(Object).

Specified by:

compareTo in interface Comparable<EntryName>

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

getFragment

@CheckForNull
public final String getFragment()

Returns the fragment of this entry name. Equivalent to toUri().getFragment().

Returns:

The fragment of this entry name.

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.

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

toUri

public final URI toUri()

Returns the URI for this entry name.

Returns:

The URI for this entry name.

Since:

TrueZIP 7.1.1