saker.sdk.support Documentation TaskDoc JavaDoc Packages
public interface IndeterminateSDKDescription extends SDKDescription
SDKDescription that may possibly select different SDKs on different environments.

The IndeterminateSDKDescription interface defines an SDK description that may locate different SDK references based on the environment that it is being resolved on. The interface also defines the pinSDKDescription(SDKReference) method that is able to create an SDKDescription that is no longer indeterminate based on a resolved SDKReference.

An example intederminate SDK description is one that selects the latest installed version of an SDK. The use-case for an indeterminate SDK description is to be able to select the same SDKs on build clusters if they have different installations. E.g.

  1. Determine the SDK using getBaseSDKDescription().
  2. Pin the SDK description with the resolved SDKReference using pinSDKDescription(SDKReference).
  3. Use the pinned SDKDescription when distributing the task to build clusters.

This SDK description plays an important role to ensure that the same SDKs are used for a given operation when the SDK installations on build cluster machines are heterogeneous.

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

Methods
public default void
Accepts a visitor and calls an appropriate visit method on it.
public boolean
Indicates whether some other object is "equal to" this one.
public SDKDescription
Gets the base SDKDescription that may possibly locate different SDK references.
public int
Returns a hash code value for the object.
public SDKDescription
Pins the resolved SDK reference to an SDK description that may no longer locate different SDKs.
public default void accept(SDKDescriptionVisitor visitor)
Overridden from: SDKDescription
Accepts a visitor and calls an appropriate visit method on it.
visitorThe visitor.
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.
Gets the base SDKDescription that may possibly locate different SDK references.

The returned SDK description will be used to resolve the SDKReference that will be passed to pinSDKDescription(SDKReference).

The base SDK description.
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.
public abstract SDKDescription pinSDKDescription(SDKReference sdkreference)
Pins the resolved SDK reference to an SDK description that may no longer locate different SDKs.

The argument will always be the result of the SDK resolution of getBaseSDKDescription().

sdkreferenceThe previously resolved SDK reference.
The pinned SDK description.