saker.compiler.utils Documentation TaskDoc JavaDoc Packages
public interface CompilationIdentifier
Interface for a compilation identifier that consists of dash separated lowercase name components.

A compilation identifier is used to uniquely identify a given compilation task in the build system. It is also used to handle option merging for configurations.

The name components may consist of characters: a-z, A-Z, 0-9, _, ., (), [], @. When a compilation identifier is constructed, the name parts are normalized to lowercase representation.

Use the valueOf(String) method to create a new instance.

This interface shouldn't be implemented by clients.

Methods
public static CompilationIdentifier
Concatenates two compilation identifiers.
public boolean
Checks if this compilation identifier equals to the argument.
public Set<String>
Gets the name parts of this compilation identifier.
public int
Gets the hash code for the compilation identifier.
public String
Converts the compilation identifier to string representation.
public static CompilationIdentifier
Creates a new compilation identifier by parsing the argument string.
public static CompilationIdentifier
Clones the argument compilation identifier.
Concatenates two compilation identifiers.

The method will take the name parts of both arguments and create a new compilation identifier that contains the union of them.

If any of the argument is null, no concatenation is performed, and the other argument is returned. If both are null, the null is returned.

firstThe first identifier.
secondThe second identifier.
The concatenated identifier based on the arguments.
public abstract boolean equals(Object obj)
Checks if this compilation identifier equals to the argument.

Two compilation identifiers equal if they contain the same name parts.

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 Set<String> getParts()
Gets the name parts of this compilation identifier.
An immutable set of name parts.
public abstract int hashCode()
Gets the hash code for the compilation identifier.

Defined as:

 Objects.hashCode(getParts());
 
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 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 abstract String toString()
Converts the compilation identifier to string representation.

Defined as:

 StringUtils.toStringJoin("-", parts);
 
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.
Creates a new compilation identifier by parsing the argument string.

The argument will be split by the dash ('-') characters in it, and each component will be part of the resulting identifier. All empty and duplicate parts are omitted. Extraneous dashes are removed.

idThe input compilation identifier to parse.
The created compilation identifier.
NullPointerExceptionIf the argument is null.
IllegalArgumentExceptionIf the argument contains name parts with invalid characters, or no name parts are present.
Clones the argument compilation identifier.

This method can be used to create a compilation identifier that is validated. As the CompilationIdentifier interface may be implemented by others, it may be necessary to validate it by creating a new instance. This can be used when you're working with compilation identifiers from external inputs.

cloneThe compilation identifier to clone.
The cloned identifier.
NullPointerExceptionIf the argument is null.
IllegalArgumentExceptionIf the argument compilation identifier is semantically invalid.