saker.build Documentation TaskDoc JavaDoc Packages
@RMIWrap(ExecutionScriptConfiguration.ProviderLocationRMIWrapper.class)
public static final class ExecutionScriptConfiguration.ScriptProviderLocation
Class holding information about how a scripting language provider should be retrieved.

The class holds a ClassPathLocation and a ClassPathServiceEnumerator instance which together specify how a script language can be loaded.

Constructors
public
ScriptProviderLocation(ClassPathLocation classPathLocation, ClassPathServiceEnumerator<extends ScriptAccessProvider> accessProviderEnumerator)
Creates a new script provider location.
Methods
public boolean
Indicates whether some other object is "equal to" this one.
public static ScriptProviderLocation
Gets the script provider location for the built-in language.
public ClassPathLocation
Gets the classpath location to load for retrieving the scripting language provider.
public ClassPathServiceEnumerator<extends ScriptAccessProvider>
Gets the service enumerator to look up the scripting language provider.
public int
Returns a hash code value for the object.
public String
Returns a string representation of the object.
Inherited methods
From: Object
public ScriptProviderLocation(ClassPathLocation classPathLocation, ClassPathServiceEnumerator<extends ScriptAccessProvider> accessProviderEnumerator) throws NullPointerException
Creates a new script provider location.
classPathLocationThe classpath location to load. May be null to use the classloader of the build system.
accessProviderEnumeratorThe service enumerator for the requested scripting language.
NullPointerExceptionIf any of the arguments are null.
public 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 script provider location for the built-in language.
The script provider location.
Gets the classpath location to load for retrieving the scripting language provider.

The classpath location may be null if the built-in script provider is used.

The classpath location or null if the built-in script provider is used.
Gets the service enumerator to look up the scripting language provider.
The service enumerator.
public 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 String toString()
Overridden from: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
a string representation of the object.