[infinispan-commits] Infinispan SVN: r823 - in trunk/core/src/main/java/org/infinispan: commands/tx and 3 other directories.

[infinispan-commits at lists.jboss.org]

Author: galder.zamarreno at jboss.com
Date: 2009-09-15 13:18:09 -0400 (Tue, 15 Sep 2009)
New Revision: 823

Modified:
   trunk/core/src/main/java/org/infinispan/commands/read/GetKeyValueCommand.java
   trunk/core/src/main/java/org/infinispan/commands/tx/CommitCommand.java
   trunk/core/src/main/java/org/infinispan/commands/tx/PrepareCommand.java
   trunk/core/src/main/java/org/infinispan/commands/tx/RollbackCommand.java
   trunk/core/src/main/java/org/infinispan/commands/tx/TransactionBoundaryCommand.java
   trunk/core/src/main/java/org/infinispan/container/entries/ExpiryHelper.java
   trunk/core/src/main/java/org/infinispan/remoting/rpc/ResponseMode.java
   trunk/core/src/main/java/org/infinispan/remoting/transport/Address.java
   trunk/core/src/main/java/org/infinispan/remoting/transport/Transport.java
Log:
Fix several documentation TODOs.

Modified: trunk/core/src/main/java/org/infinispan/commands/read/GetKeyValueCommand.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/commands/read/GetKeyValueCommand.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/commands/read/GetKeyValueCommand.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -32,7 +32,8 @@
 import org.infinispan.util.logging.LogFactory;
 
 /**
- * // TODO: MANIK: Document this
+ * Implements functionality defined by {@link org.infinispan.Cache#get(Object)} and 
+ * {@link org.infinispan.Cache#containsKey(Object)} operations
  *
  * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
  * @since 4.0

Modified: trunk/core/src/main/java/org/infinispan/commands/tx/CommitCommand.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/commands/tx/CommitCommand.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/commands/tx/CommitCommand.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -30,7 +30,7 @@
 import org.infinispan.transaction.xa.GlobalTransaction;
 
 /**
- * // TODO: MANIK: Document this
+ * Command corresponding to the 2nd phase of 2PC.
  *
  * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
  * @since 4.0

Modified: trunk/core/src/main/java/org/infinispan/commands/tx/PrepareCommand.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/commands/tx/PrepareCommand.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/commands/tx/PrepareCommand.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -40,7 +40,7 @@
 import java.util.List;
 
 /**
- * Command coresponding to the 1st phase of 2PC.
+ * Command corresponding to the 1st phase of 2PC.
  *
  * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
  * @author Mircea.Markus at jboss.com

Modified: trunk/core/src/main/java/org/infinispan/commands/tx/RollbackCommand.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/commands/tx/RollbackCommand.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/commands/tx/RollbackCommand.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -30,7 +30,7 @@
 import org.infinispan.transaction.xa.GlobalTransaction;
 
 /**
- * // TODO: MANIK: Document this
+ * Command corresponding to a transaction rollback.
  *
  * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
  * @since 4.0

Modified: trunk/core/src/main/java/org/infinispan/commands/tx/TransactionBoundaryCommand.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/commands/tx/TransactionBoundaryCommand.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/commands/tx/TransactionBoundaryCommand.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -26,7 +26,8 @@
 import org.infinispan.commands.VisitableCommand;
 
 /**
- * // TODO: MANIK: Document this
+ * An transaction boundary command that allows the retrieval of an attached 
+ * {@link org.infinispan.transaction.xa.GlobalTransaction}
  *
  * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
  * @since 4.0

Modified: trunk/core/src/main/java/org/infinispan/container/entries/ExpiryHelper.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/container/entries/ExpiryHelper.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/container/entries/ExpiryHelper.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -1,7 +1,7 @@
 package org.infinispan.container.entries;
 
 /**
- * // TODO: Manik: Document this
+ * Provide utility methods for dealing with expiration of cache entries.
  *
  * @author Manik Surtani
  * @since 4.0

Modified: trunk/core/src/main/java/org/infinispan/remoting/rpc/ResponseMode.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/remoting/rpc/ResponseMode.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/remoting/rpc/ResponseMode.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -1,7 +1,11 @@
 package org.infinispan.remoting.rpc;
 
 /**
- * // TODO: Manik: Document this!
+ * Represents different handling mechanisms when dealing with remote command responses. 
+ * These include waiting for responses from all nodes in the cluster ({@link ResponseMode#SYNCHRONOUS}}),
+ * not waiting for any responses at all ({@link ResponseMode#ASYNCHRONOUS}} or 
+ * {@link ResponseMode#ASYNCHRONOUS_WITH_SYNC_MARSHALLING}}), or waiting for first valid response 
+ * ({@link ResponseMode#WAIT_FOR_VALID_RESPONSE}})
  *
  * @author Manik Surtani
  * @since 4.0

Modified: trunk/core/src/main/java/org/infinispan/remoting/transport/Address.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/remoting/transport/Address.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/remoting/transport/Address.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -1,7 +1,7 @@
 package org.infinispan.remoting.transport;
 
 /**
- * // TODO: Manik: Document this!
+ * A destination for an Infinispan command or operation.
  *
  * @author Manik Surtani
  * @since 4.0

Modified: trunk/core/src/main/java/org/infinispan/remoting/transport/Transport.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/remoting/transport/Transport.java	2009-09-15 14:59:50 UTC (rev 822)
+++ trunk/core/src/main/java/org/infinispan/remoting/transport/Transport.java	2009-09-15 17:18:09 UTC (rev 823)
@@ -34,6 +34,7 @@
 @NonVolatile
 public interface Transport extends Lifecycle {
    // TODO discovery should be abstracted away into a separate set of interfaces such that it is not tightly coupled to the transport
+   // Galder 15/09/09: what discovery??
 
    /**
     * Initializes the transport with global cache configuration and transport-specific properties.