saker.sdk.support Documentation TaskDoc JavaDoc Packages
public interface SDKPropertyReference extends SDKValueReference<String>
Interface that references a String value derived based on the associated SDKs.

Instances of this interface are used to configure tasks with input values (properties) that are resolved from the SDKReferences in the caller context.

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.

Use create(String, String) to create a new instance.

Methods
public static SDKPropertyReference
create(String sdkname, String propertyidentifier)
Creates a new SDKPropertyReference that resolves the property for a given identifier.
public static SDKPropertyReference
createWithFormat(String format, List<extends SDKValueReference<?>> arguments)
Creates a new SDKPropertyReference that derives the property value using the given format and associated arguments.
public boolean
Indicates whether some other object is "equal to" this one.
public String
Call getValue(Map<String, ? extends SDKReference>) directly instead. (Since saker.sdk.support 0.8.3)
public String
Call getValue(Map<String, ? extends SDKReference>) directly instead. (Since saker.sdk.support 0.8.3)
public default String
getValue(Map<String, ? extends SDKReference> sdks)
Gets the derived value based on the arugment SDKs.
public int
Returns a hash code value for the object.
Inherited methods
public static SDKPropertyReference create(String sdkname, String propertyidentifier) throws NullPointerException
Creates a new SDKPropertyReference that resolves the property for a given identifier.

The created property references simply uses SDKReference.getProperty(String) to resolve the property.

sdknameThe SDK name.
propertyidentifierThe property identifier.
The created property reference.
NullPointerExceptionIf any of the arguments are null.
public static SDKPropertyReference createWithFormat(String format, List<extends SDKValueReference<?>> arguments) throws NullPointerException
Creates a new SDKPropertyReference that derives the property value using the given format and associated arguments.

Each argument SDKValueReference will be evaluated in the caller SDK context and the results are formatted with the given format string.

formatThe format string.
argumentsThe arguments.
The cretaed property reference.
NullPointerExceptionIf any of the arguments are null.
saker.sdk.support 0.8.3
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.
Call getValue(Map<String, ? extends SDKReference>) directly instead. (Since saker.sdk.support 0.8.3)
Gets the property value from the argument SDKReference.

The implementation will retrieve the property in an implementation dependent manner.

The argument SDK is the one that is associated with the SDK name in the context of the operation.

If the property cannot be retrieved from the SDK, then the method may return null or throw an exception.

sdkThe SDK.
The resolved property or null if the resolution failed.
ExceptionIf the operation failed.
public abstract String getSDKName()
Call getValue(Map<String, ? extends SDKReference>) directly instead. (Since saker.sdk.support 0.8.3)
Gets the SDK name for which this property reference is associated with.
The SDK name.
public default String getValue(Map<String, ? extends SDKReference> sdks) throws NullPointerException, Exception
Overridden from: SDKValueReference
Gets the derived value based on the arugment SDKs.

The method can access the information accessible via the argument SDKs and construct the return value based on that.

The result can be null, but implementations are encouraged to throw an appropriate exception instead.

sdksThe SDKs to derive the value from.
The derived value. May be null.
NullPointerExceptionIf the argument is null.
ExceptionIn case of failure.
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.