[jbosscache-commits] JBoss Cache SVN: r5729 - in core/trunk/src/main/java/org/jboss/cache/commands: read and 3 other directories.
jbosscache-commits at lists.jboss.org
jbosscache-commits at lists.jboss.org
Mon Apr 28 12:10:49 EDT 2008
Author: manik.surtani at jboss.com
Date: 2008-04-28 12:10:49 -0400 (Mon, 28 Apr 2008)
New Revision: 5729
Modified:
core/trunk/src/main/java/org/jboss/cache/commands/DataCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/ReversibleCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/VersionedDataCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/VisitableCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/read/AbstractDataCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/read/GetChildrenNamesCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/read/GetDataMapCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/read/GetKeyValueCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/read/GetKeysCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/read/GetNodeCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/read/GravitateDataCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/read/RemoteExistsCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/remote/AnnounceBuddyPoolNameCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/remote/AssignToBuddyGroupCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/remote/ClusteredGetCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/remote/DataGravitationCleanupCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/remote/RemoveFromBuddyGroupCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/remote/ReplicateCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/tx/CommitCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/tx/OptimisticPrepareCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/tx/PrepareCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/tx/RollbackCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/write/EvictCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/write/InvalidateCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/write/MoveCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/write/PutDataMapCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/write/PutKeyValueCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveDataCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveKeyCommand.java
core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveNodeCommand.java
Log:
Javadocs and refactoring
Modified: core/trunk/src/main/java/org/jboss/cache/commands/DataCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/DataCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/DataCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -6,7 +6,8 @@
* Commands of this type manipulate data in the cache.
*
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
+ * @since 2.2.0
*/
public interface DataCommand extends VisitableCommand
{
Modified: core/trunk/src/main/java/org/jboss/cache/commands/ReversibleCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/ReversibleCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/ReversibleCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -3,9 +3,10 @@
import org.jboss.cache.transaction.GlobalTransaction;
/**
- * A reversible command is one that can be rolled back.
+ * A reversible command is one that can be rolled back. Also typically has a reference to a {@link org.jboss.cache.transaction.GlobalTransaction}.
*
* @author Mircea.Markus at jboss.com
+ * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
* @since 2.2.0
*/
public interface ReversibleCommand extends DataCommand
@@ -15,7 +16,15 @@
*/
void rollback();
+ /**
+ * @return a GlobalTransaction associated with this command.
+ */
GlobalTransaction getGlobalTransaction();
+ /**
+ * Sets a GlobalTransaction on this command.
+ *
+ * @param gtx global transaction to set
+ */
void setGlobalTransaction(GlobalTransaction gtx);
}
Modified: core/trunk/src/main/java/org/jboss/cache/commands/VersionedDataCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/VersionedDataCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/VersionedDataCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -3,9 +3,11 @@
import org.jboss.cache.optimistic.DataVersion;
/**
- * Just like a {@link org.jboss.cache.commands.DataCommand}, except that these are versioned. And reversible too.
+ * Just like a {@link org.jboss.cache.commands.DataCommand}, except that these are versioned and reversible too. Versioning
+ * is currently used by optimistic locking, and in future will be used by MVCC as well.
*
* @author Mircea.Markus at jboss.com
+ * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
* @since 2.2.0
*/
public interface VersionedDataCommand extends ReversibleCommand
Modified: core/trunk/src/main/java/org/jboss/cache/commands/VisitableCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/VisitableCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/VisitableCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -3,7 +3,7 @@
import org.jboss.cache.InvocationContext;
/**
- * A type of command that can accept visitors, such as interceptors.
+ * A type of command that can accept {@link org.jboss.cache.commands.Visitor}s, such as {@link org.jboss.cache.interceptors.base.CommandInterceptor}s.
*
* @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
* @since 2.2.0
Modified: core/trunk/src/main/java/org/jboss/cache/commands/read/AbstractDataCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/read/AbstractDataCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/read/AbstractDataCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -7,6 +7,8 @@
import org.jboss.cache.factories.annotations.Inject;
/**
+ * An abstract class providing basic functionality of all {@link DataCommand}s.
+ *
* @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
* @since 2.2.0
*/
@@ -43,7 +45,6 @@
fqn = (Fqn) args[0];
}
-
@Override
public boolean equals(Object o)
{
Modified: core/trunk/src/main/java/org/jboss/cache/commands/read/GetChildrenNamesCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/read/GetChildrenNamesCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/read/GetChildrenNamesCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -12,14 +12,14 @@
import java.util.Set;
/**
+ * This command retrieves the names of children for a specific Fqn, as defined by {@link org.jboss.cache.Node#getChildrenNames()}
+ * <p/>
+ * This is the equivalent of the old MethodCallDefinitions.getChildrenNamesMethodLocal method call from 2.1.x.
+ * <p/>
+ *
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
-/*
- equiv of old:
- 1 - getChildrenNamesMethodLocal_id
- */
-
public class GetChildrenNamesCommand extends AbstractDataCommand
{
public static final int METHOD_ID = 23;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/read/GetDataMapCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/read/GetDataMapCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/read/GetDataMapCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -9,15 +9,13 @@
/**
* Implements functionality defined by {@link org.jboss.cache.Cache#getData(org.jboss.cache.Fqn)}
+ * <p/>
+ * This is the equivalent of the old MethodCallDefinitions.getDataMapMethodLocal method call from 2.1.x.
+ * <p/>
*
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
-/*
- equiv of old:
- 1 - getDataMapMethodLocal_id
- */
-
public class GetDataMapCommand extends AbstractDataCommand
{
public static final int METHOD_ID = 24;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/read/GetKeyValueCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/read/GetKeyValueCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/read/GetKeyValueCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -10,16 +10,14 @@
import org.jboss.cache.notifications.Notifier;
/**
- * Implements functionality defined by {@link org.jboss.cache.CacheSPI#get(String, Object)}
+ * Implements functionality defined by {@link org.jboss.cache.Cache#get(String, Object)}
+ * <p/>
+ * This is the equivalent of the old MethodCallDefinitions.getKeyValueMethodLocal method call from 2.1.x.
+ * <p/>
*
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
-/*
- equiv of old:
- 1 - getKeyValueMethodLocal_id
- */
-
public class GetKeyValueCommand extends AbstractDataCommand
{
public static final int METHOD_ID = 26;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/read/GetKeysCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/read/GetKeysCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/read/GetKeysCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -10,15 +10,13 @@
/**
* Implements functionality defined by {@link org.jboss.cache.Cache#getKeys(org.jboss.cache.Fqn)}
+ * <p/>
+ * This is the equivalent of the old MethodCallDefinitions.getKeysMethodLocal method call from 2.1.x.
+ * <p/>
*
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
-/*
- equiv of old:
- 1 - getKeysMethodLocal_id
- */
-
public class GetKeysCommand extends AbstractDataCommand
{
public static final int METHOD_ID = 25;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/read/GetNodeCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/read/GetNodeCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/read/GetNodeCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -6,15 +6,13 @@
/**
* Implements functionality defined by {@link org.jboss.cache.Cache#getNode(org.jboss.cache.Fqn)}
+ * <p/>
+ * This is the equivalent of the old MethodCallDefinitions.getNodeMethodLocal method call from 2.1.x.
+ * <p/>
*
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
-/*
- equiv of old:
- 1 - getNodeMethodLocal_id
- */
-
public class GetNodeCommand extends AbstractDataCommand
{
public static final int METHOD_ID = 31;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/read/GravitateDataCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/read/GravitateDataCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/read/GravitateDataCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -21,15 +21,14 @@
import java.util.TreeSet;
/**
- * Used with buddy replication's data gravitation interceptor. If marshalling is necessary, ensure that the cache is
- * configured to use {@link org.jboss.cache.config.Configuration#useRegionBasedMarshalling} and the {@link org.jboss.cache.Region}
- * pertaining to the Fqn passed in is activated, and has an appropriate ClassLoader.
+ * Used with buddy replication's {@link org.jboss.cache.interceptors.DataGravitatorInterceptor}.
+ * <p/>
+ * This is the equivalent of the old MethodCallDefinitions.dataGravitationMethod method call from 2.1.x.
+ * <p/>
+ *
+ * @author Manik Surtani
+ * @since 2.2.0
*/
-/*
- equiv of old:
- 1 - dataGravitationMethod_id
- */
-
public class GravitateDataCommand extends AbstractDataCommand
{
public static final int METHOD_ID = 35;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/read/RemoteExistsCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/read/RemoteExistsCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/read/RemoteExistsCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -11,17 +11,15 @@
* not attempt to load nodes from a cache loader (may return false if a
* node has been evicted).
* <p/>
- * Specifically used by the {@link org.jboss.cache.loader.ClusteredCacheLoader} to implement {@link org.jboss.cache.loader.CacheLoader#exists(org.jboss.cache.Fqn)}
+ * Specifically used by the {@link org.jboss.cache.loader.ClusteredCacheLoader} to
+ * implement {@link org.jboss.cache.loader.CacheLoader#exists(org.jboss.cache.Fqn)}
* <p/>
+ * This is the equivalent of the old MethodCallDefinitions.existsMethod method call from 2.1.x.
+ * <p/>
*
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
-/*
- equiv of old:
- 1 - existsMethod_id
- */
-
public class RemoteExistsCommand extends AbstractDataCommand
{
public static final int METHOD_ID = 16;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/remote/AnnounceBuddyPoolNameCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/remote/AnnounceBuddyPoolNameCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/remote/AnnounceBuddyPoolNameCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -8,8 +8,12 @@
import org.jgroups.Address;
/**
+ * Announces a buddy pool name to the cluster. This is not a {@link org.jboss.cache.commands.VisitableCommand} and hence
+ * not passed up the {@link org.jboss.cache.interceptors.base.CommandInterceptor} chain.
+ * <p/>
+ *
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
public class AnnounceBuddyPoolNameCommand extends AbstractReplicableCommand
{
Modified: core/trunk/src/main/java/org/jboss/cache/commands/remote/AssignToBuddyGroupCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/remote/AssignToBuddyGroupCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/remote/AssignToBuddyGroupCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -10,8 +10,12 @@
import java.util.Map;
/**
+ * Assigns a buddy to a group. This is not a {@link org.jboss.cache.commands.VisitableCommand} and hence
+ * not passed up the {@link org.jboss.cache.interceptors.base.CommandInterceptor} chain.
+ * <p/>
+ *
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
public class AssignToBuddyGroupCommand extends AbstractReplicableCommand
{
Modified: core/trunk/src/main/java/org/jboss/cache/commands/remote/ClusteredGetCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/remote/ClusteredGetCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/remote/ClusteredGetCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -16,8 +16,13 @@
import java.util.List;
/**
+ * Issues a clustered get call, for use primarily by the {@link org.jboss.cache.loader.ClusteredCacheLoader}. This is
+ * not a {@link org.jboss.cache.commands.VisitableCommand} and hence
+ * not passed up the {@link org.jboss.cache.interceptors.base.CommandInterceptor} chain.
+ * <p/>
+ *
* @author Mircea.Markus at jboss.com
- * @since 2.2
+ * @since 2.2.0
*/
public class ClusteredGetCommand extends AbstractReplicableCommand
{
Modified: core/trunk/src/main/java/org/jboss/cache/commands/remote/DataGravitationCleanupCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/remote/DataGravitationCleanupCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/remote/DataGravitationCleanupCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -19,7 +19,10 @@
import java.util.List;
/**
- * Data gravitation cleanup handler.
+ * Data gravitation cleanup handler. Primarily used by the {@link org.jboss.cache.interceptors.DataGravitatorInterceptor}.
+ * This is not a {@link org.jboss.cache.commands.VisitableCommand} and hence
+ * not passed up the {@link org.jboss.cache.interceptors.base.CommandInterceptor} chain.
+ * <p/>
*
* @author Mircea.Markus at jboss.com
* @since 2.2
Modified: core/trunk/src/main/java/org/jboss/cache/commands/remote/RemoveFromBuddyGroupCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/remote/RemoveFromBuddyGroupCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/remote/RemoveFromBuddyGroupCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -5,6 +5,10 @@
import org.jboss.cache.factories.annotations.Inject;
/**
+ * Removes a buddy from a group. This is not a {@link org.jboss.cache.commands.VisitableCommand} and hence
+ * not passed up the {@link org.jboss.cache.interceptors.base.CommandInterceptor} chain.
+ * <p/>
+ *
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
Modified: core/trunk/src/main/java/org/jboss/cache/commands/remote/ReplicateCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/remote/ReplicateCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/remote/ReplicateCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -13,7 +13,12 @@
import java.util.List;
/**
- * Command that implements cluster replication logic.
+ * Command that implements cluster replication logic. Essentially mimics the replicate() and replicateAll() methods
+ * in 2.1.x, we may need to revisit the usefulness of such a command.
+ * <p/>
+ * This is not a {@link org.jboss.cache.commands.VisitableCommand} and hence
+ * not passed up the {@link org.jboss.cache.interceptors.base.CommandInterceptor} chain.
+ * <p/>
*
* @author Mircea.Markus at jboss.com
* @since 2.2
Modified: core/trunk/src/main/java/org/jboss/cache/commands/tx/CommitCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/tx/CommitCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/tx/CommitCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -5,13 +5,11 @@
import org.jboss.cache.transaction.GlobalTransaction;
/**
+ * Represents a commit() call, the 2nd part of a 2-phase commit.
+ *
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- commitMethod_id
- */
-
public class CommitCommand extends AbstractTransactionCommand
{
public static final int METHOD_ID = 11;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/tx/OptimisticPrepareCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/tx/OptimisticPrepareCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/tx/OptimisticPrepareCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -10,13 +10,11 @@
import java.util.Map;
/**
+ * An optimistic version of {@link PrepareCommand}.
+ *
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- optimisticPrepareMethod_id
- */
-
public class OptimisticPrepareCommand extends PrepareCommand
{
public static final int METHOD_ID = 18;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/tx/PrepareCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/tx/PrepareCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/tx/PrepareCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -9,15 +9,11 @@
import java.util.List;
/**
- * Marker for a cache command action.
+ * The prepare phase of a 2-phase commit, or the single prepare/commit phase of a single-phase commit.
*
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- prepareMethod_id
- */
-
public class PrepareCommand extends AbstractTransactionCommand
{
public static final int METHOD_ID = 10;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/tx/RollbackCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/tx/RollbackCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/tx/RollbackCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -5,13 +5,11 @@
import org.jboss.cache.transaction.GlobalTransaction;
/**
+ * The rollback phase of a 2-phase commit.
+ *
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- rollbackMethod_id
- */
-
public class RollbackCommand extends AbstractTransactionCommand
{
public static final int METHOD_ID = 12;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/write/EvictCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/write/EvictCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/write/EvictCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -8,17 +8,11 @@
import java.util.List;
/**
- * Implements functionality defined by {@link org.jboss.cache.CacheSPI#evict(org.jboss.cache.Fqn)}
+ * Implements functionality defined by {@link org.jboss.cache.Cache#evict(org.jboss.cache.Fqn)}
*
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- equiv of old:
- 1 - evictNodeMethodLocal_id
- 2 - evictVersionedNodeMethodLocal_id
- */
-
public class EvictCommand extends AbstractVersionedDataCommand
{
public static final int METHOD_ID = 8;
@@ -34,7 +28,7 @@
/**
* Returns false if the node still exists; i.e. was only data removed because it still has children.
*
- * @see org.jboss.cache.interceptors.EvictionInterceptor#handleEvictFqnCommand(org.jboss.cache.InvocationContext, EvictCommand)
+ * @see org.jboss.cache.interceptors.EvictionInterceptor#visitEvictFqnCommand(org.jboss.cache.InvocationContext, EvictCommand)
* there is wehere this attribute is used
*/
public Object perform(InvocationContext ctx)
Modified: core/trunk/src/main/java/org/jboss/cache/commands/write/InvalidateCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/write/InvalidateCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/write/InvalidateCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -32,11 +32,6 @@
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- equiv of old:
- 1 - invalidateMethodLocal_id
- */
-
public class InvalidateCommand extends EvictCommand
{
public static final int METHOD_ID = 47;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/write/MoveCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/write/MoveCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/write/MoveCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -17,11 +17,6 @@
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- equiv of old:
- 1 - moveMethodLocal_id
- */
-
public class MoveCommand extends AbstractDataCommand implements ReversibleCommand
{
public static final int METHOD_ID = 36;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/write/PutDataMapCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/write/PutDataMapCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/write/PutDataMapCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -15,19 +15,11 @@
import java.util.Map;
/**
- * Implements functionality defined by {@link org.jboss.cache.CacheSPI#put(String, java.util.Map)}
+ * Implements functionality defined by {@link org.jboss.cache.Cache#put(String, java.util.Map)}.
*
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- equiv of old:
- 1 - putDataEraseMethodLocal_id
- 2 - putDataMethodLocal_id
- 3 - putDataEraseVersionedMethodLocal_id
- 4 - putDataVersionedMethodLocal_id
- */
-
public class PutDataMapCommand extends AbstractVersionedDataCommand
{
public static final int METHOD_ID = 1;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/write/PutKeyValueCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/write/PutKeyValueCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/write/PutKeyValueCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -15,20 +15,12 @@
import java.util.Map;
/**
- * Implements functionality defined by {@link org.jboss.cache.CacheSPI#put(org.jboss.cache.Fqn, Object, Object)}.
+ * Implements functionality defined by {@link org.jboss.cache.Cache#put(org.jboss.cache.Fqn, Object, Object)}. Also implements
+ * {@link org.jboss.cache.Cache#putForExternalRead(org.jboss.cache.Fqn, Object, Object)} if {@link #isPutForExternalRead()} is true.
*
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-
-/*
- equiv of old:
- 1 - putKeyValMethodLocal_id
- 2 - putKeyValVersionedMethodLocal_id
- 3 - putForExternalReadMethodLocal_id
- 4 - putForExternalReadVersionedMethodLocal_id
- */
-
public class PutKeyValueCommand extends AbstractVersionedDataCommand
{
public static final int METHOD_ID = 3;
@@ -43,7 +35,7 @@
private Object key;
private Object value;
private boolean createUndoOps;
- private boolean isPutForExternalRead;
+ private boolean putForExternalRead;
private Object oldValue;
public PutKeyValueCommand()
@@ -51,7 +43,7 @@
trace = log.isTraceEnabled();
}
- public PutKeyValueCommand(GlobalTransaction gtx, Fqn fqn, Object key, Object value, boolean createUndoOps, boolean isPutForExternalRead)
+ public PutKeyValueCommand(GlobalTransaction gtx, Fqn fqn, Object key, Object value, boolean createUndoOps, boolean putForExternalRead)
{
this();
this.globalTransaction = gtx;
@@ -59,7 +51,7 @@
this.key = key;
this.value = value;
this.createUndoOps = createUndoOps;
- this.isPutForExternalRead = isPutForExternalRead;
+ this.putForExternalRead = putForExternalRead;
}
public Object perform(InvocationContext ctx)
@@ -105,7 +97,7 @@
public boolean isPutForExternalRead()
{
- return isPutForExternalRead;
+ return putForExternalRead;
}
public Object getKey()
@@ -137,11 +129,11 @@
{
if (isVersioned())
{
- return isPutForExternalRead ? PUT_FOR_EXT_READ_VERSIONED_METHOD_ID : VERSIONED_METHOD_ID;
+ return putForExternalRead ? PUT_FOR_EXT_READ_VERSIONED_METHOD_ID : VERSIONED_METHOD_ID;
}
else
{
- return isPutForExternalRead ? PUT_FOR_EXT_READ_METHOD_ID : METHOD_ID;
+ return putForExternalRead ? PUT_FOR_EXT_READ_METHOD_ID : METHOD_ID;
}
}
@@ -162,7 +154,7 @@
key = args[2];
value = args[3];
createUndoOps = (Boolean) args[4];
- isPutForExternalRead = (commandId == PUT_FOR_EXT_READ_METHOD_ID || commandId == PUT_FOR_EXT_READ_VERSIONED_METHOD_ID);
+ putForExternalRead = (commandId == PUT_FOR_EXT_READ_METHOD_ID || commandId == PUT_FOR_EXT_READ_VERSIONED_METHOD_ID);
if (isVersionedId(commandId)) dataVersion = (DataVersion) args[5];
}
@@ -176,7 +168,7 @@
PutKeyValueCommand that = (PutKeyValueCommand) o;
if (createUndoOps != that.createUndoOps) return false;
- if (isPutForExternalRead != that.isPutForExternalRead) return false;
+ if (putForExternalRead != that.putForExternalRead) return false;
if (globalTransaction != null ? !globalTransaction.equals(that.globalTransaction) : that.globalTransaction != null)
return false;
if (key != null ? !key.equals(that.key) : that.key != null) return false;
@@ -193,7 +185,7 @@
result = 31 * result + (key != null ? key.hashCode() : 0);
result = 31 * result + (value != null ? value.hashCode() : 0);
result = 31 * result + (createUndoOps ? 1 : 0);
- result = 31 * result + (isPutForExternalRead ? 1 : 0);
+ result = 31 * result + (putForExternalRead ? 1 : 0);
return result;
}
@@ -213,7 +205,7 @@
", key=" + key +
", value=" + value +
", createUndoOps=" + createUndoOps +
- ", isPutForExternalRead=" + isPutForExternalRead +
+ ", isPutForExternalRead=" + putForExternalRead +
", oldValue=" + oldValue +
'}';
}
Modified: core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveDataCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveDataCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveDataCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -19,12 +19,6 @@
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- equiv of old:
- 1 - removeDataMethodLocal_id
- 2 - removeDataVersionedMethodLocal_id
- */
-
public class RemoveDataCommand extends AbstractVersionedDataCommand
{
public static final int METHOD_ID = 7;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveKeyCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveKeyCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveKeyCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -19,12 +19,6 @@
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- equiv of old:
- 1 - removeKeyMethodLocal_id
- 1 - removeKeyVersionedMethodLocal_id
- */
-
public class RemoveKeyCommand extends AbstractVersionedDataCommand
{
public static final int METHOD_ID = 6;
Modified: core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveNodeCommand.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveNodeCommand.java 2008-04-28 15:46:50 UTC (rev 5728)
+++ core/trunk/src/main/java/org/jboss/cache/commands/write/RemoveNodeCommand.java 2008-04-28 16:10:49 UTC (rev 5729)
@@ -18,12 +18,6 @@
* @author Mircea.Markus at jboss.com
* @since 2.2
*/
-/*
- equiv of old:
- 1 - removeNodeMethodLocal_id
- 2 - removeNodeVersionedMethodLocal_id
- */
-
public class RemoveNodeCommand extends AbstractVersionedDataCommand
{
public static final int METHOD_ID = 5;
More information about the jbosscache-commits
mailing list