org.electrocodeogram.cpc.core.api.hub.event
Class CloneEvent

java.lang.Object
  org.electrocodeogram.cpc.core.api.hub.event.CPCEvent
      org.electrocodeogram.cpc.core.api.hub.event.CloneEvent

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<CPCEvent>

Direct Known Subclasses:

CloneModificationEvent, CloneNotificationEvent, ClonePersistenceEvent

public abstract class CloneEvent
extends CPCEvent

Abstract base event for all clone data related events.

Author:

vw

See Also:

CPCEvent

Constructor Summary

CloneEvent(ICloneFile cloneFile)
Create a new clone event, this abstract constructor needs to be called by all sub-implementations.

Method Summary

ICloneFile	getCloneFile() Retrieves the clone file for this event.
protected java.lang.String	subToString() Should be called as part of Object.toString() implementations of sub-classes.

Methods inherited from class org.electrocodeogram.cpc.core.api.hub.event.CPCEvent

checkSeal, clone, compareTo, getCreationTime, isValid, seal, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CloneEvent

public CloneEvent(ICloneFile cloneFile)

Create a new clone event, this abstract constructor needs to be called by all sub-implementations. The clone file value may be NULL if the event is not related to a specific file.

Parameters:

cloneFile - the clone file which this event is related to, may be NULL.

Method Detail

getCloneFile

public ICloneFile getCloneFile()

Retrieves the clone file for this event.
If the event is not specifically related to a single clone file, this value is NULL.

NOTE: In case of a file deletion this clone file entry may point to a no longer existing file and it may also be no longer possible to retrieve this file or any data about it from the store provider.

Returns:

the clone file which this event is related to, may be NULL.

subToString

protected java.lang.String subToString()

Should be called as part of Object.toString() implementations of sub-classes.

Returns:

data values from this class, never null.