svn commit: r1339653 - /commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java

[gg...@apache.org]

Author: ggregory
Date: Thu May 17 15:31:26 2012
New Revision: 1339653

URL: http://svn.apache.org/viewvc?rev=1339653&view=rev
Log:
Javadoc clean ups.

Modified:
    commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java

Modified: commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java
URL: http://svn.apache.org/viewvc/commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java?rev=1339653&r1=1339652&r2=1339653&view=diff
==============================================================================
--- commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java (original)
+++ commons/proper/vfs/trunk/core/src/main/java/org/apache/commons/vfs2/RandomAccessContent.java Thu May 17 15:31:26 2012
@@ -22,65 +22,71 @@ import java.io.IOException;
 import java.io.InputStream;
 
 /**
- * Random Access Content.
+ * Provides random access over content.
  */
 public interface RandomAccessContent extends DataOutput, DataInput
 {
     /**
      * Returns the current offset in this file.
-     *
-     * @return the offset from the beginning of the file, in bytes,
-     *         at which the next read or write occurs.
-     * @throws IOException if an I/O error occurs.
+     * 
+     * @return the offset from the beginning of the file, in bytes, at which the next read or write occurs.
+     * @throws IOException
+     *             if an I/O error occurs.
      */
     long getFilePointer() throws IOException;
 
     /**
-     * Sets the file-pointer offset, measured from the beginning of this
-     * file, at which the next read or write occurs.  The offset may be
-     * set beyond the end of the file. Setting the offset beyond the end
-     * of the file does not change the file length.  The file length will
-     * change only by writing after the offset has been set beyond the end
-     * of the file.
-     * <br/>
-     * <b>Notice: If you use {@link #getInputStream()} you have to reget the InputStream after
-     * calling {@link #seek(long)}</b>
-     *
-     * @param pos the offset position, measured in bytes from the
-     *            beginning of the file, at which to set the file
+     * Sets the file-pointer offset, measured from the beginning of this file, at which the next read or write occurs.
+     * <p>
+     * The offset may be set beyond the end of the file. Setting the offset beyond the end of the file does not change
+     * the file length. The file length will change only by writing after the offset has been set beyond the end of the
+     * file.
+     * </p>
+     * <p>
+     * <b>Notice: If you use {@link #getInputStream()} you have to re-get the InputStream after calling
+     * {@link #seek(long)}</b>
+     * </p>
+     * 
+     * @param pos
+     *            the offset position, measured in bytes from the beginning of the file, at which to set the file
      *            pointer.
-     * @throws IOException if <code>pos</code> is less than
-     *                     <code>0</code> or if an I/O error occurs.
+     * @throws IOException
+     *             if <code>pos</code> is less than <code>0</code> or if an I/O error occurs.
      */
     void seek(long pos) throws IOException;
 
     /**
      * Returns the length of this file.
-     *
+     * 
      * @return the length of this file, measured in bytes.
-     * @throws IOException if an I/O error occurs.
+     * @throws IOException
+     *             if an I/O error occurs.
      */
     long length() throws IOException;
 
     /**
-     * Closes this random access file stream and releases any system
-     * resources associated with the stream. A closed random access
-     * file cannot perform input or output operations and cannot be
-     * reopened.
-     * <p/>
-     * <p> If this file has an associated channel then the channel is closed
-     * as well.
-     *
-     * @throws IOException if an I/O error occurs.
+     * Closes this random access file stream and releases any system resources associated with the stream. </p>
+     * <p>
+     * A closed random access file cannot perform input or output operations and cannot be reopened.
+     * </p>
+     * <p>
+     * If this file has an associated channel then the channel is closed as well.
+     * <p>
+     * 
+     * @throws IOException
+     *             if an I/O error occurs.
      */
     void close() throws IOException;
 
     /**
      * Get the input stream.
-     * <br/>
-     * <b>Notice: If you use {@link #seek(long)} you have to reget the InputStream</b>
+     * <p>
+     * <b>Notice: If you use {@link #seek(long)} you have to re-get the InputStream</b>
+     * </p>
+     * 
      * @return the InputStream.
-     * @throws IOException if an I/O error occurs.
+     * @throws IOException
+     *             if an I/O error occurs.
      */
     InputStream getInputStream() throws IOException;
 }