org.keridwen.core.data.storage.packet
Class DataPacket<ObjectType>

java.lang.Object
  org.keridwen.core.data.storage.packet.DataPacket<ObjectType>

Direct Known Subclasses:

DataPacketSafe, DataPacketUnsafe

public abstract class DataPacket<ObjectType>
extends Object

Author:

JeT - Artenum, Benoit Thiebault - Artenum This DataPacket class is the storage space of any kind of data within Keridwen. It stores the data content, name, type and other kind of specific data used to track data life cycle (date, usages, requests ...)

Constructor Summary

DataPacket(UniqueIdGenerator<DataPacketId> idGenerator)
Default constructor

Method Summary

boolean	addDataPacketListener(DataPacketListener listener) add a listener to the list of managed listeners
protected void	fireDataPacketEvent(DataPacketEvent event) fire an event to the Data packet listeners
void	forceReadLockRelease() force the packet to release its lock Dangerous usage.
void	forceWriteLockRelease() force the packet to release its lock Dangerous usage.
abstract Class<?>	getPacketDataType() Type of data managed by this packet
DataPacketId	getPacketId()
boolean	isReadInProgress()
boolean	isWriteInProgress()
boolean	removeDataPacketListener(DataPacketListener listener) remove a listener from the list of managed listeners

Methods inherited from class java.lang.Object

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

Constructor Detail

DataPacket

public DataPacket(UniqueIdGenerator<DataPacketId> idGenerator)

Default constructor

Method Detail

getPacketId

public final DataPacketId getPacketId()

Returns:

the packetId

forceReadLockRelease

public void forceReadLockRelease()

force the packet to release its lock Dangerous usage. It breaks the concurrency management

forceWriteLockRelease

public void forceWriteLockRelease()

force the packet to release its lock Dangerous usage. It breaks the concurrency management

isReadInProgress

public boolean isReadInProgress()

Returns:

the readLock

isWriteInProgress

public boolean isWriteInProgress()

Returns:

the writeLock

getPacketDataType

public abstract Class<?> getPacketDataType()

Type of data managed by this packet

Returns:

the packetDataType

addDataPacketListener

public boolean addDataPacketListener(DataPacketListener listener)

add a listener to the list of managed listeners

Parameters:

listener - listener to add

removeDataPacketListener

public boolean removeDataPacketListener(DataPacketListener listener)

remove a listener from the list of managed listeners

Parameters:

listener - listener to remove

fireDataPacketEvent

protected void fireDataPacketEvent(DataPacketEvent event)

fire an event to the Data packet listeners