net.sf.ehcache.transaction.xa.commands
Class StoreRemoveCommand

java.lang.Object
  net.sf.ehcache.transaction.xa.commands.AbstractStoreCommand
      net.sf.ehcache.transaction.xa.commands.StoreRemoveCommand

All Implemented Interfaces:

Command

public class StoreRemoveCommand
extends AbstractStoreCommand

Represents a remove operation to be executed on a Store.

Author:

Alex Snaps

Constructor Summary

StoreRemoveCommand(Object key, Element oldElement)
Create a StoreRemoveCommand

Method Summary

CacheEntry	getEntry() Getter to the cache entry to be removed
Object	getObjectKey() Get the key of the element this command is working on
boolean	isPut(Object key) Is this command represents adding a key to the store
boolean	isRemove(Object key) Is this command represents removing a key to the store

Methods inherited from class net.sf.ehcache.transaction.xa.commands.AbstractStoreCommand

getNewElement, getOldElement, prepare, rollback

Methods inherited from class java.lang.Object

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

Constructor Detail

StoreRemoveCommand

public StoreRemoveCommand(Object key,
                          Element oldElement)

Create a StoreRemoveCommand

Parameters:

key - the key of the element to remove

oldElement - the element in the underlying store at the time this command is created

Method Detail

isPut

public boolean isPut(Object key)

Is this command represents adding a key to the store

Parameters:

key - the key

Returns:

true, if this command would try to add an Element for key, otherwise false

isRemove

public boolean isRemove(Object key)

Is this command represents removing a key to the store

Parameters:

key - the key

Returns:

true, if this command would try to remove an Element for key, otherwise false

getObjectKey

public Object getObjectKey()

Get the key of the element this command is working on

Returns:

the element's key

getEntry

public CacheEntry getEntry()

Getter to the cache entry to be removed

Returns:

the cache entry