Content descriptors are often used with files do determine if their contents have changed compared to a previous version. Although they are mostly used with files, they can be associated to other kind of datas as well. It is recommended that instances are lightweight.
A content descriptor contains one method which is responsible for detecting changes when a previous content
descriptor instance is passed to them. They check any changes that is present between the two instances, and return
true
if they are different.
Subclasses should satisfy the equals(
Implementers of this interface are recommended to provide a stable hash code. This is in order for any clients to
take advantage of the cacheability of build tasks. Note, that this
implies that implementations should not be enum
s.
It is strongly recommended that subclasses implement the Externalizable interface.
As a design decision, it was chosen to define this interface instead of just relying on the equals(
public boolean | Checks if this content descriptor is exactly the same as the parameter. |
public int | hashCode() Returns a hash code value for the object. |
public default boolean | isChanged( Detects changes between this content descriptor and the previous one. |
It is not required by implementations that if equals(true
, then
isChanged(false
. As a possible scenario, two contents can
equal, and still report changes between same contents. (E.g. NullContentDescriptor which equal, but
consider everything changed)
By employing this mechanism implementations can be more error-prone in regards with deleted/missing/erroneous
contents.
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.
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
Object.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.)
The default implementation compares the two objects using equals(
Implementations are encouraged to check the type of the parameter using instanceof
before casting
them. It is further encouraged to check the content differences against interfaces instead of direct class
implementations.
One can think about this function as this
is the expected content of a file, and the parameter is
the actual contents. If this method returns true
then the file associated with this
should replace the file associated with the parameter contents. This is mainly used when synchronizing files in
memory to the filesystem.
null
to represent that the previous content
doesn't exist.true
if the contents described by this descriptor differs from the parameter.