Return-Path: 
 <accumulo-commits-return-205-apmail-incubator-accumulo-commits-archive=incubator.apache.org@incubator.apache.org>
X-Original-To: apmail-incubator-accumulo-commits-archive@minotaur.apache.org
Delivered-To: apmail-incubator-accumulo-commits-archive@minotaur.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id DC084927B
	for <apmail-incubator-accumulo-commits-archive@minotaur.apache.org>;
 Thu, 27 Oct 2011 19:48:46 +0000 (UTC)
Received: (qmail 51638 invoked by uid 500); 27 Oct 2011 19:48:46 -0000
Delivered-To: apmail-incubator-accumulo-commits-archive@incubator.apache.org
Received: (qmail 51610 invoked by uid 500); 27 Oct 2011 19:48:46 -0000
Mailing-List: contact accumulo-commits-help@incubator.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:accumulo-commits-help@incubator.apache.org>
List-Unsubscribe: <mailto:accumulo-commits-unsubscribe@incubator.apache.org>
List-Post: <mailto:accumulo-commits@incubator.apache.org>
List-Id: <accumulo-commits.incubator.apache.org>
Reply-To: accumulo-dev@incubator.apache.org
Delivered-To: mailing list accumulo-commits@incubator.apache.org
Received: (qmail 51603 invoked by uid 99); 27 Oct 2011 19:48:46 -0000
Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 27 Oct 2011 19:48:46 +0000
X-ASF-Spam-Status: No, hits=-2000.0 required=5.0
	tests=ALL_TRUSTED
X-Spam-Check-By: apache.org
Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 27 Oct 2011 19:48:45 +0000
Received: from eris.apache.org (localhost [127.0.0.1])
	by eris.apache.org (Postfix) with ESMTP id 6384D23888CD;
	Thu, 27 Oct 2011 19:48:25 +0000 (UTC)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1189970 - in /incubator/accumulo:
 branches/1.3/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
 trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
Date: Thu, 27 Oct 2011 19:48:25 -0000
To: accumulo-commits@incubator.apache.org
From: billie@apache.org
X-Mailer: svnmailer-1.0.8-patched
Message-Id: <20111027194825.6384D23888CD@eris.apache.org>

Author: billie
Date: Thu Oct 27 19:48:24 2011
New Revision: 1189970

URL: http://svn.apache.org/viewvc?rev=1189970&view=rev
Log:
ACCUMULO-15 cleaned up javadoc a bit

Modified:
    incubator/accumulo/branches/1.3/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
    incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java

Modified: incubator/accumulo/branches/1.3/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/branches/1.3/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java?rev=1189970&r1=1189969&r2=1189970&view=diff
==============================================================================
--- incubator/accumulo/branches/1.3/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java (original)
+++ incubator/accumulo/branches/1.3/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java Thu Oct 27 19:48:24 2011
@@ -36,10 +36,9 @@ public interface SortedKeyValueIterator<
    * @param source <tt>SortedKeyValueIterator</tt> source to read data from.
    * @param options <tt>Map</tt> map of string option names to option values.
    * @param env <tt>IteratorEnvironment</tt> environment in which iterator is being run.
-   * @throws IOException TODO
+   * @throws IOException unused.
    * @exception IllegalArgumentException if there are problems with the options.
    * @exception UnsupportedOperationException if not supported.
-   * @exception IOException
    */
   void init(SortedKeyValueIterator<K,V> source, Map<String,String> options, IteratorEnvironment env) throws IOException;
   
@@ -55,7 +54,7 @@ public interface SortedKeyValueIterator<
    * Advances to the next K,V pair.
    * 
    * @throws IOException if an I/O error occurs.
-   * @throws IllegalStateException if called before seek.
+   * @exception IllegalStateException if called before seek.
    * @exception NoSuchElementException if next element doesn't exist.
    */
   void next() throws IOException;
@@ -98,7 +97,7 @@ public interface SortedKeyValueIterator<
    * The behavior is unspecified if init is called after deepCopy either on the original or the copy.
    * 
    * @param env <tt>IteratorEnvironment</tt> environment in which iterator is being run.
-   * @return <tt>SortedKeyValueIterator</tt> a copy of this iterator (with the same source and settings)
+   * @return <tt>SortedKeyValueIterator</tt> a copy of this iterator (with the same source and settings).
    * @exception UnsupportedOperationException if not supported.
    */
   SortedKeyValueIterator<K,V> deepCopy(IteratorEnvironment env);

Modified: incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
URL: http://svn.apache.org/viewvc/incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java?rev=1189970&r1=1189969&r2=1189970&view=diff
==============================================================================
--- incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java (original)
+++ incubator/accumulo/trunk/src/core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java Thu Oct 27 19:48:24 2011
@@ -36,10 +36,9 @@ public interface SortedKeyValueIterator<
    * @param source <tt>SortedKeyValueIterator</tt> source to read data from.
    * @param options <tt>Map</tt> map of string option names to option values.
    * @param env <tt>IteratorEnvironment</tt> environment in which iterator is being run.
-   * @throws IOException TODO
+   * @throws IOException unused.
    * @exception IllegalArgumentException if there are problems with the options.
    * @exception UnsupportedOperationException if not supported.
-   * @exception IOException
    */
   void init(SortedKeyValueIterator<K,V> source, Map<String,String> options, IteratorEnvironment env) throws IOException;
   
@@ -55,7 +54,7 @@ public interface SortedKeyValueIterator<
    * Advances to the next K,V pair.
    * 
    * @throws IOException if an I/O error occurs.
-   * @throws IllegalStateException if called before seek.
+   * @exception IllegalStateException if called before seek.
    * @exception NoSuchElementException if next element doesn't exist.
    */
   void next() throws IOException;
@@ -98,7 +97,7 @@ public interface SortedKeyValueIterator<
    * The behavior is unspecified if init is called after deepCopy either on the original or the copy.
    * 
    * @param env <tt>IteratorEnvironment</tt> environment in which iterator is being run.
-   * @return <tt>SortedKeyValueIterator</tt> a copy of this iterator (with the same source and settings)
+   * @return <tt>SortedKeyValueIterator</tt> a copy of this iterator (with the same source and settings).
    * @exception UnsupportedOperationException if not supported.
    */
   SortedKeyValueIterator<K,V> deepCopy(IteratorEnvironment env);