You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by jb...@apache.org on 2009/03/31 15:25:16 UTC

svn commit: r760437 - in /incubator/cassandra/trunk/src/org/apache/cassandra: concurrent/ db/ io/ net/

Author: jbellis
Date: Tue Mar 31 13:25:05 2009
New Revision: 760437

URL: http://svn.apache.org/viewvc?rev=760437&view=rev
Log:
apply patch from johano fixing #31

Modified:
    incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/IStage.java
    incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/StageManager.java
    incubator/cassandra/trunk/src/org/apache/cassandra/db/CalloutManager.java
    incubator/cassandra/trunk/src/org/apache/cassandra/db/ICompactSerializer2.java
    incubator/cassandra/trunk/src/org/apache/cassandra/db/Memtable.java
    incubator/cassandra/trunk/src/org/apache/cassandra/db/PrimaryKey.java
    incubator/cassandra/trunk/src/org/apache/cassandra/io/IFileReader.java
    incubator/cassandra/trunk/src/org/apache/cassandra/io/SequenceFile.java
    incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncCallback.java
    incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncResult.java
    incubator/cassandra/trunk/src/org/apache/cassandra/net/IMessagingService.java
    incubator/cassandra/trunk/src/org/apache/cassandra/net/SelectorManager.java

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/IStage.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/IStage.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/IStage.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/IStage.java Tue Mar 31 13:25:05 2009
@@ -31,8 +31,8 @@
 public interface IStage 
 {
     /**
-     * Get the name of the associated stage
-     * @return
+     * Get the name of the associated stage.
+     * @return name of the associated stage.
      */
     public String getName();
     
@@ -43,7 +43,7 @@
     public ExecutorService getInternalThreadPool();
     
     /**
-     * This method is used to execute a peice of code on
+     * This method is used to execute a piece of code on
      * this stage. The idea is that the <i>run()</i> method
      * of this Runnable instance is invoked on a thread from a
      * thread pool that belongs to this stage.
@@ -52,14 +52,14 @@
     public void execute(Runnable runnable);
     
     /**
-     * This method is used to execute a peice of code on
+     * This method is used to execute a piece of code on
      * this stage which returns a Future pointer. The idea
      * is that the <i>call()</i> method of this Runnable 
      * instance is invoked on a thread from a thread pool 
      * that belongs to this stage.
      
      * @param callable instance that needs to be invoked.
-     * @return
+     * @return the future return object from the callable.
      */
     public Future<Object> execute(Callable<Object> callable);
     
@@ -68,9 +68,9 @@
      * that execute periodically. 
      * 
      * @param command the task to execute.
-     * @param initialDelay the time to delay first execution 
+     * @param delay the time to delay first execution 
      * @param unit the time unit of the initialDelay and period parameters 
-     * @return
+     * @return the future return object from the runnable.
      */
     public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit); 
       
@@ -81,7 +81,7 @@
      * @param initialDelay the time to delay first execution
      * @param period the period between successive executions
      * @param unit the time unit of the initialDelay and period parameters 
-     * @return
+     * @return the future return object from the runnable.
      */
     public ScheduledFuture<?> scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit); 
     
@@ -92,7 +92,7 @@
      * @param initialDelay the time to delay first execution
      * @param delay  the delay between the termination of one execution and the commencement of the next.
      * @param unit the time unit of the initialDelay and delay parameters 
-     * @return
+     * @return the future return object from the runnable.
      */
     public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit);
     
@@ -107,14 +107,14 @@
     
     /**
      * Checks if the stage has been shutdown.
-     * @return
+     * @return true if shut down, otherwise false.
      */
     public boolean isShutdown();
     
     /**
      * This method returns the number of tasks that are 
      * pending on this stage to be executed.
-     * @return
+     * @return task count.
      */
     public long getTaskCount();
 }

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/StageManager.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/StageManager.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/StageManager.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/concurrent/StageManager.java Tue Mar 31 13:25:05 2009
@@ -52,7 +52,7 @@
      * Returns the stage that we are currently executing on.
      * This relies on the fact that the thread names in the
      * stage have the name of the stage as the prefix.
-     * @return
+     * @return Returns the stage that we are currently executing on.
      */
     public static IStage getCurrentStage()
     {
@@ -97,7 +97,7 @@
      * This method gets the number of tasks on the
      * stage's internal queue.
      * @param stage name of the stage
-     * @return
+     * @return stage task count.
      */
     public static long getStageTaskCount(String stage)
     {

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/db/CalloutManager.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/db/CalloutManager.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/db/CalloutManager.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/db/CalloutManager.java Tue Mar 31 13:25:05 2009
@@ -187,7 +187,7 @@
     /**
      * Execute the specified callout.
      * @param callout to be executed.
-     * @params args arguments to be passed to the callouts.
+     * @param args arguments to be passed to the callouts.
      */
     public Object executeCallout(String callout, Object ... args)
     {

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/db/ICompactSerializer2.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/db/ICompactSerializer2.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/db/ICompactSerializer2.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/db/ICompactSerializer2.java Tue Mar 31 13:25:05 2009
@@ -40,7 +40,6 @@
      * argument.
      * 
      * @param dis DataInput from which we need to deserialize.
-     * @param columnNames list of items that are required.
      * @throws IOException
      * @return type which contains the specified items.
 	*/
@@ -52,7 +51,6 @@
      * 
      * @param dis DataInput from which we need to deserialize.
      * @param name name of the desired field.
-     * @param count count of the number of fields required.
      * @throws IOException
      * @return the deserialized type.
     */

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/db/Memtable.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/db/Memtable.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/db/Memtable.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/db/Memtable.java Tue Mar 31 13:25:05 2009
@@ -166,8 +166,9 @@
 
     /**
      * Compares two Memtable based on creation time.
-     * @param rhs
-     * @return
+     * @param rhs Memtable to compare to.
+     * @return a negative integer, zero, or a positive integer as this object
+     * is less than, equal to, or greater than the specified object.
      */
     public int compareTo(Memtable rhs)
     {

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/db/PrimaryKey.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/db/PrimaryKey.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/db/PrimaryKey.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/db/PrimaryKey.java Tue Mar 31 13:25:05 2009
@@ -93,7 +93,8 @@
      * is an OPHF then the key is used.
      * 
      * @param rhs primary against which we wish to compare.
-     * @return
+     * @return a negative integer, zero, or a positive integer as this object
+     * is less than, equal to, or greater than the specified object.
      */
     public int compareTo(PrimaryKey rhs)
     {

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/io/IFileReader.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/io/IFileReader.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/io/IFileReader.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/io/IFileReader.java Tue Mar 31 13:25:05 2009
@@ -84,7 +84,7 @@
      * This method dumps the next key/value into the DataOuputStream
      * passed in.
      *
-     * @param dos - DataOutputStream that needs to be filled.
+     * @param bufOut DataOutputStream that needs to be filled.
      * @return number of bytes read.
      * @throws IOException 
     */
@@ -95,7 +95,7 @@
      * passed in.
      *
      * @param key key we are interested in.
-     * @param dos DataOutputStream that needs to be filled.
+     * @param bufOut DataOutputStream that needs to be filled.
      * @param section region of the file that needs to be read
      * @throws IOException
      * @return the number of bytes read.
@@ -107,7 +107,7 @@
      * passed in.
      *
      * @param key key we are interested in.
-     * @param dos DataOutputStream that needs to be filled.
+     * @param bufOut DataOutputStream that needs to be filled.
      * @param column name of the column in our format.
      * @param section region of the file that needs to be read
      * @throws IOException
@@ -121,8 +121,8 @@
      * specific data as it will have indexes.
      *
      * @param key - key we are interested in.
-     * @param dos - DataOutputStream that needs to be filled.
-     * @param cfName - The name of the column family only without the ":"
+     * @param bufOut - DataOutputStream that needs to be filled.
+     * @param columnFamilyName The name of the column family only without the ":"
      * @param columnNames - The list of columns in the cfName column family
      * 					     that we want to return
      * @param section region of the file that needs to be read
@@ -137,7 +137,7 @@
      * passed in.
      *
      * @param key key we are interested in.
-     * @param dos DataOutputStream that needs to be filled.
+     * @param bufOut DataOutputStream that needs to be filled.
      * @param column name of the column in our format.
      * @param timeRange time range we are interested in.
      * @param section region of the file that needs to be read

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/io/SequenceFile.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/io/SequenceFile.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/io/SequenceFile.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/io/SequenceFile.java Tue Mar 31 13:25:05 2009
@@ -848,7 +848,7 @@
          * specific data as it will have indexes.
          *
          * @param key key we are interested in.
-         * @param dos DataOutputStream that needs to be filled.
+         * @param bufOut DataOutputStream that needs to be filled.
          * @param cf the IColumn we want to read
          * @param section region of the file that needs to be read
          * @return total number of bytes read/considered
@@ -975,8 +975,8 @@
          * specific data as it will have indexes.
          
          * @param key key we are interested in.
-         * @param dos DataOutputStream that needs to be filled.
-         * @param column name of the column in our format.
+         * @param bufOut DataOutputStream that needs to be filled.
+         * @param cf name of the column in our format.
          * @param timeRange time range we are interested in.
          * @param section region of the file that needs to be read
          * @throws IOException
@@ -1087,8 +1087,8 @@
          * specific data as it will have indexes.
          *
          * @param key key we are interested in.
-         * @param dos DataOutputStream that needs to be filled.
-         * @param cfName The name of the column family only without the ":"
+         * @param bufOut DataOutputStream that needs to be filled.
+         * @param cf The name of the column family only without the ":"
          * @param columnNames The list of columns in the cfName column family that we want to return
          * @param section region of the file that needs to be read
          * @return total number of bytes read/considered
@@ -1235,7 +1235,7 @@
          * This method dumps the next key/value into the DataOuputStream
          * passed in.
          *
-         * @param dos - DataOutputStream that needs to be filled.
+         * @param bufOut DataOutputStream that needs to be filled.
          * @return total number of bytes read/considered
          */
         public long next(DataOutputBuffer bufOut) throws IOException
@@ -1276,7 +1276,7 @@
          * passed in.
          *
          * @param key - key we are interested in.
-         * @param dos - DataOutputStream that needs to be filled.
+         * @param bufOut DataOutputStream that needs to be filled.
          * @param section region of the file that needs to be read
          * @return total number of bytes read/considered
          */

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncCallback.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncCallback.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncCallback.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncCallback.java Tue Mar 31 13:25:05 2009
@@ -25,7 +25,7 @@
 public interface IAsyncCallback 
 {
 	/**
-	 * @param response responses to be returned
+	 * @param msg responses to be returned
 	 */
 	public void response(Message msg);
     

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncResult.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncResult.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncResult.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/net/IAsyncResult.java Tue Mar 31 13:25:05 2009
@@ -67,8 +67,6 @@
     
     /**
      * Store the result obtained for the submitted task.
-     * @param result result wrapped in an Object[]
-     * 
      * @param result the response message
      */
     public void result(Message result);

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/net/IMessagingService.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/net/IMessagingService.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/net/IMessagingService.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/net/IMessagingService.java Tue Mar 31 13:25:05 2009
@@ -137,7 +137,7 @@
      * whose results are harnessed via the <i>IAsyncResult</i>
      * @param messages groups of grouped messages.
      * @param to destination for the groups of messages
-     * @param the callback handler to be invoked for the responses
+     * @param cb the callback handler to be invoked for the responses
      * @return the group id which is basically useless - it is only returned for API's
      *         to look compatible.
      */

Modified: incubator/cassandra/trunk/src/org/apache/cassandra/net/SelectorManager.java
URL: http://svn.apache.org/viewvc/incubator/cassandra/trunk/src/org/apache/cassandra/net/SelectorManager.java?rev=760437&r1=760436&r2=760437&view=diff
==============================================================================
--- incubator/cassandra/trunk/src/org/apache/cassandra/net/SelectorManager.java (original)
+++ incubator/cassandra/trunk/src/org/apache/cassandra/net/SelectorManager.java Tue Mar 31 13:25:05 2009
@@ -58,8 +58,7 @@
     /**
      * Constructor, which is private since there is only one selector per JVM.
      * 
-     * @param profile
-     *            DESCRIBE THE PARAMETER
+     * @param name name of thread. 
      */
     protected SelectorManager(String name)
     {