ExternalArchiveKey

public interface ExternalArchiveKey

Identifies a specific content of an external archive.

The interface contains information that identifies an external archive and optionally an entry in it. The interface is used to distinguish differentiate the loading origins of an ExternalArchive.

The interface defines its properties to be immutable.

This interface is not to be implemented by clients.

Use create to create a new instance.

Methods

public static ExternalArchiveKey	create(URI uri) Creates a new instance for the main archive.
public static ExternalArchiveKey	create(URI uri, String entryname) Creates a new instance.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public String	getEntryName() Gets the name of the entry that was extracted from the main archive.
public URI	getUri() Gets the URI origin of the external archive.
public int	hashCode() Returns a hash code value for the object.

public static ExternalArchiveKey create(URI uri) throws NullPointerException

Creates a new instance for the main archive.

This is the same as:

 create(uri, null)

uriThe URI of the main archive.

The created ExternalArchiveKey.

NullPointerExceptionIf the argument is null.

public static ExternalArchiveKey create(URI uri, String entryname) throws NullPointerException

Creates a new instance.

uriThe URI of the main archive.

entrynameThe entry name or null if none.

The created ExternalArchiveKey.

NullPointerExceptionIf the uri is null.

public abstract boolean equals(Object obj)

Overridden from: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

objthe reference object with which to compare.

true if this object is the same as the obj argument; false otherwise.

Object.hashCode()

HashMap

public abstract String getEntryName()

Gets the name of the entry that was extracted from the main archive.

This property specifies the full path in the main archive from where the entry was extracted from and loaded as an ExternalArchive.

If this property is null, then the ExternalArchiveKey represents the main archive without any entry extraction.

The full entry name or null.

public abstract URI getUri()

Gets the URI origin of the external archive.

The URI is used to load the archive from. If getEntryName() is null, then this ExternalArchiveKey represents the main archive that was loaded.

The URI. Non-null.

public abstract int hashCode()

Overridden from: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.

Object.equals(Object)

System.identityHashCode(Object)