au.com.cybersearch2.classyjpa.entity

Class EntityKey

java.lang.Object

au.com.cybersearch2.classyjpa.entity.EntityKey

All Implemented Interfaces:

Comparable<EntityKey>

public class EntityKey
extends Object
implements Comparable<EntityKey>

EntityKey Used by Entity Manager to identify entity objects

Author:

Andrew Bowley 05/05/2014

Constructor Summary

Constructors

Constructor and Description
EntityKey(Class<?> entityClass, Object primaryKey) Create EntityKey object

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(EntityKey another) Compares this object with the specified object for order.
boolean	equals(Object another) Indicates whether some other object is "equal to" this one.
int	hashCode() Returns a hash code value for the object.
boolean	isDirty() Returns true if updates need to be persisted on the entity identifed by this key
void	setDirty(boolean dirty) Set dirty flag

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityKey

public EntityKey(Class<?> entityClass,
         Object primaryKey)

Create EntityKey object

Parameters:

entityClass - Class of entity object

primaryKey - Primary key of object

Method Detail

compareTo

public int compareTo(EntityKey another)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface Comparable<EntityKey>

Parameters:

another - The object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

isDirty

public boolean isDirty()

Returns true if updates need to be persisted on the entity identifed by this key

Returns:

boolean

setDirty

public void setDirty(boolean dirty)

Set dirty flag

Parameters:

dirty - boolean

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

equals

public boolean equals(Object another)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

another - The reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

hashCode(), Hashtable