SDKReference

public interface SDKReference

Provides access to the paths and properties of an SDK.

An SDKReference encloses the information provided by an SDK. It is the result of the resolution of an SDKDescription. An SDK provides access to paths and properties for specific identifiers.

The path and property identifiers that an SDK accepts are determined by the actual SDK that is used. Different SDKs usually support different identifiers.

Clients are recommended to implement this interface.

Clients should adhere to the contract specified by hashCode() and equals(Object).

Implementations are recommended to implement the Externalizable interface.

Design note: The interface doesn't provide a method to query the supported path and property identifiers. In general, when one wants to use an SDK, the identifiers must be known beforehand, and the need for querying them usually signals an unconventional configuration that this API is not intended to provide support for.

UserSDKDescription.createSDKReference(Map<String, SakerPath>, Map<String, String>)

Methods

public boolean	equals(Object obj) Checks if this SDK reference is the same as the argument.
public SakerPath	getPath(String identifier) Gets a path provided by this SDK for the given identifier.
public String	getProperty(String identifier) Gets a property provided by this SDK for the given identifier.
public int	hashCode() Returns a hash code value for the object.

public abstract boolean equals(Object obj)

Checks if this SDK reference is the same as the argument.

Two SDK references are the same, if they provide access to the same paths and properties for the same identifiers, and with the same values.

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.

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

public abstract SakerPath getPath(String identifier) throws Exception

Gets a path provided by this SDK for the given identifier.

The returned path may be interpreted in an SDK dependent manner, but in most cases, it will be a local path on the local file system for the JVM that is running the caller code.

The identifiers may or may not be interpreted in a case-insensitive way by the SDK implementation.

If the identifier is not recognized by the SDK, it may either return null, or throw an exception.

identifierThe identifier for which to look up the path.

The path or null if there's no path for the given identifier.

ExceptionIf the operation fails.

public abstract String getProperty(String identifier) throws Exception

Gets a property provided by this SDK for the given identifier.

The returned property may be interpreted in an SDK dependent manner. Its format depends on the semantics provided by the SDK.

The identifiers may or may not be interpreted in a case-insensitive way by the SDK implementation.

If the identifier is not recognized by the SDK, it may either return null, or throw an exception.

identifierThe identifier for which to look up the property.

The property value or null if there's no property for the given identifier.

ExceptionIf the operation fails.

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)