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(
This interface shouldn't be implemented by clients.
public static CompilationIdentifier | concat( Concatenates two compilation identifiers. |
public boolean | Checks if this compilation identifier equals to the argument. |
public Set< | getParts() Gets the name parts of this compilation identifier. |
public int | hashCode() Gets the hash code for the compilation identifier. |
public String | toString() Converts the compilation identifier to string representation. |
public static CompilationIdentifier | Creates a new compilation identifier by parsing the argument string. |
public static CompilationIdentifier | valueOf( Clones the argument compilation identifier. |
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.
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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.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 inequals
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 thehashCode
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 thehashCode
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.)
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())
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.
null
.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.
null
.