Top Description Fields Constructors Methods
net.sf.ehcache.transaction.xa.commands

public Class StoreRemoveCommand

extends AbstractStoreCommand
Class Inheritance
Imports
net.sf.ehcache.CacheEntry, .Element
Represents a remove operation to be executed on a net.sf.ehcache.store.Store.
Author
Alex Snaps

Field Summary

Modifier and TypeField and Description
private Object
key

Constructor Summary

AccessConstructor and Description
public
StoreRemoveCommand(final Object
the key of the element to remove
key, final Element
the element in the underlying store at the time this command is created
oldElement)

Create a StoreRemoveCommand

Method Summary

Modifier and TypeMethod and Description
public CacheEntry

Returns:

the cache entry
getEntry()

Getter to the cache entry to be removed

public Object
getObjectKey()

Implements net.sf.ehcache.transaction.xa.commands.Command.getObjectKey.

Get the key of the element this command is working on
public boolean
isPut(Object
the key
key)

Implements net.sf.ehcache.transaction.xa.commands.Command.isPut.

Is this command represents adding a key to the store
public boolean
isRemove(Object
the key
key)

Implements net.sf.ehcache.transaction.xa.commands.Command.isRemove.

Is this command represents removing a key to the store
Inherited from net.sf.ehcache.transaction.xa.commands.AbstractStoreCommand:
getNewElementgetOldElementpreparerollback

Field Detail

keyback to summary
private Object key

Constructor Detail

StoreRemoveCommandback to summary
public StoreRemoveCommand(final Object key, final Element oldElement)

Create a StoreRemoveCommand

Parameters
key:Object

the key of the element to remove

oldElement:Element

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

Method Detail

getEntryback to summary
public CacheEntry getEntry()

Getter to the cache entry to be removed

Returns:CacheEntry

the cache entry

getObjectKeyback to summary
public Object getObjectKey()

Implements net.sf.ehcache.transaction.xa.commands.Command.getObjectKey.

Doc from net.sf.ehcache.transaction.xa.commands.Command.getObjectKey.

Get the key of the element this command is working on

Returns:Object

the element's key

isPutback to summary
public boolean isPut(Object key)

Implements net.sf.ehcache.transaction.xa.commands.Command.isPut.

Doc from net.sf.ehcache.transaction.xa.commands.Command.isPut.

Is this command represents adding a key to the store

Parameters
key:Object

the key

Returns:boolean

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

isRemoveback to summary
public boolean isRemove(Object key)

Implements net.sf.ehcache.transaction.xa.commands.Command.isRemove.

Doc from net.sf.ehcache.transaction.xa.commands.Command.isRemove.

Is this command represents removing a key to the store

Parameters
key:Object

the key

Returns:boolean

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