Module org.pojomatic

Package org.pojomatic.internal

Class ClassProperties

java.lang.Object

org.pojomatic.internal.ClassProperties

public class ClassProperties
extends Object

The properties of a class used for Pojomator.doHashCode(Object), Pojomator.doEquals(Object, Object), and Pojomator.doToString(Object).

Method Summary

Modifier and Type	Method	Description
static ClassProperties	forClass(Class<?> pojoClass)	Get an instance for the given pojoClass.
Set<PropertyElement>	getAllProperties()	Get the union of all properties used for any Pojomator methods.
Collection<PropertyElement>	getEqualsProperties()	Gets the properties to use for Pojomator.doEquals(Object, Object).
Collection<PropertyElement>	getHashCodeProperties()	Gets the properties to use for Pojomator.doHashCode(Object).
Collection<PropertyElement>	getToStringProperties()	Gets the properties to use for Pojomator.doToString(Object).
boolean	isCompatibleForEquals(Class<?> otherClass)	Whether instances of otherClass are candidates for being equal to instances of the class this ClassProperties instance was created for.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forClass

public static ClassProperties forClass(Class<?> pojoClass)
                                throws NoPojomaticPropertiesException

Get an instance for the given pojoClass. Instances are cached, so calling this method repeatedly is not inefficient.

Parameters:

pojoClass - the class to inspect for properties

Returns:

The ClassProperties for pojoClass.

Throws:

NoPojomaticPropertiesException - if pojoClass has no properties annotated for use with Pojomatic.

getEqualsProperties

public Collection<PropertyElement> getEqualsProperties()

Gets the properties to use for Pojomator.doEquals(Object, Object).

Returns:

the properties to use for Pojomator.doEquals(Object, Object).

getHashCodeProperties

public Collection<PropertyElement> getHashCodeProperties()

Gets the properties to use for Pojomator.doHashCode(Object).

Returns:

the properties to use for Pojomator.doHashCode(Object).

getToStringProperties

public Collection<PropertyElement> getToStringProperties()

Gets the properties to use for Pojomator.doToString(Object).

Returns:

the properties to use for Pojomator.doToString(Object).

getAllProperties

public Set<PropertyElement> getAllProperties()

Get the union of all properties used for any Pojomator methods. The resulting set will have a predictable iteration order: first, the ordered list of elements used for equals, followed by an ordered list of any additional elements used for toString.

Returns:

the union of all properties used for any Pojomator methods.

isCompatibleForEquals

public boolean isCompatibleForEquals(Class<?> otherClass)

Whether instances of otherClass are candidates for being equal to instances of the class this ClassProperties instance was created for.

Parameters:

otherClass - the class to check for compatibility for equals with.

Returns:

true if instances of otherClass are candidates for being equal to instances of the class this ClassProperties instance was created for, or false otherwise.