EnvironmentSDKDescription

public interface EnvironmentSDKDescription extends SDKDescription

saker.sdk.support.api.EnvironmentSDKDescription

saker.sdk.support.api.SDKDescription

SDKDescription that represents an SDK that is resolved from a given build environment.

This SDK description interface defines a strategy using which the SDKReference can be acquired from a given build environment.

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.

You can use create(EnvironmentProperty<? extends SDKReference>) to create a new instance without implementing this interface.

Methods

public default void	accept(SDKDescriptionVisitor visitor) Accepts a visitor and calls an appropriate `visit` method on it.
public static EnvironmentSDKDescription	create(EnvironmentProperty<? extends SDKReference> property) Creates a new EnvironmentSDKDescription that retrieves the SDKReference using the argument EnvironmentProperty.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public SDKReference	getSDK(SakerEnvironment environment) Gets the SDK reference based on the argument build environment.
public int	hashCode() Returns a hash code value for the object.

public default void accept(SDKDescriptionVisitor visitor)

Overridden from: SDKDescription

Accepts a visitor and calls an appropriate visit method on it.

visitorThe visitor.

public static EnvironmentSDKDescription create(EnvironmentProperty<? extends SDKReference> property) throws NullPointerException

Creates a new EnvironmentSDKDescription that retrieves the SDKReference using the argument EnvironmentProperty.

If the property doesn't return and instance of SDKReference, then a ClassCastException is thrown when it is being retrieved.

propertyThe property that is used to retrieve the SDKReference.

The created SDK description.

NullPointerExceptionIf the argument 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 SDKReference getSDK(SakerEnvironment environment) throws Exception

Gets the SDK reference based on the argument build environment.

The implementation may retrieve an SDKReference in any way it sees fit.

environmentThe build environment.

The SDK reference. Never null.

ExceptionIf the operation failed. E.g. the SDK was not found in the argument environment.

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)