saker.build Documentation TaskDoc JavaDoc Packages
public interface ClassPathLocation
Stateless interface which represent an unique location of a classpath.

Classpath locations uniquely specify the location of a classpath that is to be loaded. Implementations should adhere to the equals(Object) and hashCode() contract.

Two classpath locations are equal if they will load themselves in the same manner.

Each classpath location has an identifier which should uniquely identify the location. It is recommended that it is a hash of some input, or other uniquely identifying function is performed to derive it.

It is strongly recommended that classpath locations are RMI transferrable.

Methods
public boolean
Checks if this object represents the same classpath location as the parameter.
public String
Gets the unique identifier for the classpath location.
public ClassPathLoader
Creates a new classpath loader which is able to load the specified classpath to a given location.
public int
Returns a hash code value for the object.
public abstract boolean equals(Object obj)
Checks if this object represents the same classpath location as the parameter.

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.
Gets the unique identifier for the classpath location.

The identifiers should be reasonably short. They should be representable in the file system as file names, meaning they should not contain any special character that a file name cannot contain. They may include the slash ('/') character.

It is not required that classpath locations with the same identifier equal, but if they equal, they must return the same identifiers.

Identifiers are usually used by external managers to determine file system storage locations. If they include slashes, usually subdirectories are created accordingly.

The identifier for this classpath location.
public abstract ClassPathLoader getLoader() throws IOException
Creates a new classpath loader which is able to load the specified classpath to a given location.
The created classpath loader.
IOExceptionIn case of I/O error.
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.