BundleKey

public interface BundleKey extends BundleIdentifierHolder

saker.nest.bundle.BundleKey

saker.nest.bundle.BundleIdentifierHolder

Interface for identifying a bundle in a configured bundle storage view.

The interface is based on a given StorageViewKey and BundleIdentifier that specifies a bundle. BundleKey object are not directly used by the repository classes, but are to be used by clients to specify a bundle location in a unique format.

Instances of this interface can be compared by equality and serialized. If two bundle keys equal then the associated bundle is to be loaded from the same location. It doesn't ensure that the contents of the bundles are the same.

Bundle keys can be created using the create(StorageViewKey, BundleIdentifier) function.

This interface is not to be implemented by clients.

Methods

public static BundleKey	create(StorageViewKey storageviewkey, BundleIdentifier bundleid) Creates a new BundleKey with the given arguments.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public BundleIdentifier	getBundleIdentifier() Gets the bundle identifier of the bundle key.
public StorageViewKey	getStorageViewKey() Gets the storage view key from where the bundle should be retrieved from.
public int	hashCode() Returns a hash code value for the object.

public static BundleKey create(StorageViewKey storageviewkey, BundleIdentifier bundleid) throws NullPointerException

Creates a new BundleKey with the given arguments.

storageviewkeyThe storage view key or null if the bundle key should be interpreted in a way that the bundle identifier is to be resolved against the root bundle lookup.

bundleidThe bundle identifier.

The created bundle key.

NullPointerExceptionIf the bundle identifier 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 BundleIdentifier getBundleIdentifier()

Gets the bundle identifier of the bundle key.

The bundle identifier. (Never null.)

public abstract StorageViewKey getStorageViewKey()

Gets the storage view key from where the bundle should be retrieved from.

The storage view key or null if the root bundle lookup should be used to resolve the identifier.

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)