net.sf.mmm.util.entity.base

Class AbstractRevisionedEntity<ID>

java.lang.Object

net.sf.mmm.util.entity.base.AbstractGenericEntity<ID>

net.sf.mmm.util.entity.base.AbstractRevisionedEntity<ID>

Type Parameters:

ID - is the type of the primary key.

All Implemented Interfaces:

Serializable, Entity, GenericEntity<ID>, MutableGenericEntity<ID>, MutableRevisionedEntity<ID>, RevisionedEntity<ID>, AttributeReadId<ID>

public abstract class AbstractRevisionedEntity<ID>
extends AbstractGenericEntity<ID>
implements MutableRevisionedEntity<ID>

This is the abstract base-class that implementations of MutableRevisionedEntity should inherit from (if possible).

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Number	revision
private static long	serialVersionUID

Fields inherited from interface net.sf.mmm.util.entity.api.RevisionedEntity

LATEST_REVISION

Constructor Summary

Constructors

Constructor and Description
AbstractRevisionedEntity() The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Number	getRevision() This method gets the revision of this entity.
int	hashCode()
void	setRevision(Number revision) This method sets the revision of this entity.
protected void	toString(StringBuilder buffer) Method to extend Object.toString() logic.

Methods inherited from class net.sf.mmm.util.entity.base.AbstractGenericEntity

getId, getModificationCounter, setId, setModificationCounter

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.entity.api.MutableGenericEntity

setId, setModificationCounter

Methods inherited from interface net.sf.mmm.util.entity.api.GenericEntity

getId, getModificationCounter

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

revision

private Number revision

Constructor Detail

AbstractRevisionedEntity

public AbstractRevisionedEntity()

The constructor.

Method Detail

getRevision

public Number getRevision()

Description copied from interface: RevisionedEntity

This method gets the revision of this entity. The latest revision of an entity will always return null. Otherwise this object is a historic entity and it will be read-only so modifications are NOT permitted.

Specified by:

getRevision in interface RevisionedEntity<ID>

Returns:

the revision or RevisionedEntity.LATEST_REVISION (null) if this is the latest revision.

setRevision

public void setRevision(Number revision)

Description copied from interface: MutableRevisionedEntity

This method sets the revision of this entity.
ATTENTION:
This operation should only be used in specific cases and if you are aware of what you are doing as this attribute is managed by the persistence. However, for final freedom we decided to add this method to the API (e.g. to copy from transfer-object to persistent-entity and vice-versa).

Specified by:

setRevision in interface MutableRevisionedEntity<ID>

Parameters:

revision - is the new value of RevisionedEntity.getRevision().

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractGenericEntity<ID>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractGenericEntity<ID>

toString

protected void toString(StringBuilder buffer)

Method to extend Object.toString() logic.

Overrides:

toString in class AbstractGenericEntity<ID>

Parameters:

buffer - is the StringBuilder where to append the string representation.