|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pojomatic.internal.PojomatorImpl<T>
public class PojomatorImpl<T>
Constructor Summary | |
---|---|
PojomatorImpl(java.lang.Class<T> clazz)
Creates an instance for clazz . |
Method Summary | |
---|---|
Differences |
doDiff(T instance,
T other)
Compute the differences between instance and other among the properties
examined by Pojomator.doEquals(Object, Object) . |
boolean |
doEquals(T instance,
java.lang.Object other)
Compute whether instance and other are equal to each other in the sense of
Object 's equals method. |
int |
doHashCode(T instance)
Compute the hashCode for a given instance of T . |
java.lang.String |
doToString(T instance)
Compute the toString representation for a given instance of T . |
boolean |
isCompatibleForEquality(java.lang.Class<?> otherClass)
Compute whether otherClass is compatible for equality with T . |
java.lang.String |
toString()
Return a simple String representation of this Pojomator. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PojomatorImpl(java.lang.Class<T> clazz) throws NoPojomaticPropertiesException
clazz
.
clazz
- the class
NoPojomaticPropertiesException
- if clazz
has no properties annotated for use
with PojomaticMethod Detail |
---|
public boolean doEquals(T instance, java.lang.Object other)
Pojomator
instance
and other
are equal to each other in the sense of
Object
's equals
method. For two instances to be
considered equal, the first requirement is that their classes must be compatible for equality,
as described in the documentation for Pojomator.isCompatibleForEquality(Class)
.
More precisely, if other
is null, this method returns false
. Otherwise, if
isCompatibleForEquals(other.getClass())
would return
false, then this method will return false. Otherwise, this method will return true provided
that each property of instance
which has a PojomaticPolicy
other than
TO_STRING
or NONE
is equal to the corresponding property of other
in
the following sense:
null
, or
equals method of Arrays
returns true, orArrays.deepEquals(Object[], Object[])
returns true, orp
in instance
is an object not of array type, and instanceP.equals(otherP)
returns true.
doEquals
in interface Pojomator<T>
instance
- the instance to test against - must not be null
other
- the instance to test
true
if instance
should be considered equal to other
, and
false
otherwise.Object.equals(Object)
public boolean isCompatibleForEquality(java.lang.Class<?> otherClass)
Pojomator
otherClass
is compatible for equality with T
.
Classes A
and B
are compatible for equality if
they share a common superclass C
, and for every class D
which
is a proper subclass of C
and a superclass of A
or B
(including
the classes A
and B
themselves), the following hold:
D
has not added additional properties for inclusion in the equals
calculation, andD
has not been annotated with OverridesEquals
T
is an interface or is annotated with SubclassCannotOverrideEquals
,
then all subclasses of T
are automatically assumed by T
's Pojomator
to be compatible for equals with each other and with T
. Note that in this case.
to add an OverridesEquals
annotation or additional
properties for inclusion in equals
to a subclass of T
will
result in a violation of the contract for Object.equals(Object)
.
isCompatibleForEquality
in interface Pojomator<T>
otherClass
- the class to check for compatibility for equality with T
true
if otherClass
is compatible for equality with T
, and
false
otherwise.public int doHashCode(T instance)
Pojomator
T
.
This is done by computing the hashCode of each property which has a PojomaticPolicy
of
HASHCODE_EQUALS
or ALL
(using 0 when the property is null), and combining them in a fashion similar to that of
List.hashCode()
.
doHashCode
in interface Pojomator<T>
instance
- the instance to compute the hashCode for - must not be null
instance
Object.hashCode()
public java.lang.String doToString(T instance)
Pojomator
toString
representation for a given instance of T
.
The format used depends on the
PojoFormatter
used for the POJO, and the PropertyFormatter
of each property.
For example, suppose a class Person
has properties firstName
and
lastName
which are included in its String
representation.
No PojoFormatter
or PropertyFormatter
are specified, so the defaults are used.
In particular, instances of DefaultPropertyFormatter
will be created for
firstName
and lastName
(referred to here as firstNameFormatter
and
lastNameFormatter
, respectively). Let firstNameProperty
and
lastNameProperty
refer to the instances of PropertyElement
referring to the
properties firstName
and lastName
respectively.
For a non-null Person
instance, the String
representation will be created by
creating an instance of DefaultPojoFormatter
for the Person
class (referred to
here as personFormatter
), and then concatenating the results of following:
personFormatter.getToStringPrefix(Person.class)
personFormatter.getPropertyPrefix(firstNameProperty)
firstNameFormatter.format(firstName)
personFormatter.getPropertySuffix(firstNameProperty)
personFormatter.getPropertyPrefix(lastNameProperty)
lastNameFormatter.format(lastName)
personFormatter.getPropertySuffix(lasttNameProperty)
personFormatter.getToStringSuffix(Person.class)
doToString
in interface Pojomator<T>
instance
- the instance to compute the toString
representation for - must not be null
toString
representation of instance
Object.toString()
,
Property.name()
public java.lang.String toString()
Pojomator
toString
in interface Pojomator<T>
toString
in class java.lang.Object
public Differences doDiff(T instance, T other)
Pojomator
instance
and other
among the properties
examined by Pojomator.doEquals(Object, Object)
. Assuming that instance
and other
are both non-null and have types which are compatible for equals, it is guaranteed that invoking
Differences.areEqual()
on the returned object will return true iff
instance.equals(other)
.
doDiff
in interface Pojomator<T>
instance
- the instance to diff againstother
- the instance to diff
instance
and other
among the properties examined by Pojomator.doEquals(Object, Object)
.Pojomator.doEquals(Object, Object)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |