saker.sdk.support Documentation TaskDoc JavaDoc Packages
public interface SDKPathCollectionReference extends SDKValueReference<Collection<SakerPath>>
Interface providing access to a collection of paths derived from SDKs.

The interface is similar to SDKPathReference, however, it can return a variable number of paths instead of one. It can be used when the number of paths that are associated with a given operation cannot be determined statically, and may be different amount based on other properties of the SDKs.

Clients may implement this interface. When doing so, make sure to adhere to the hashCode() and equals(Object) contract. Implementers are also recommended to implement Externalizable.

A delegate instance from SDKPathReference can be created using valueOf(SDKPathReference).

saker.sdk.support 0.8.3
Methods
public boolean
Indicates whether some other object is "equal to" this one.
public int
Returns a hash code value for the object.
public static SDKPathCollectionReference
Creates a new instance based on the argument SDKPathReference.
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.
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.
Creates a new instance based on the argument SDKPathReference.

The returned path collection reference will return a singleton set that contains the path returned by the argument.

pathrefThe path reference.
The delegate path collection reference.
NullPointerExceptionIf the argument is null.