From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../com/amazon/carbonado/spi/RAFInputStream.html | 370 +++++++++++++++++++++ 1 file changed, 370 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/spi/RAFInputStream.html (limited to 'apidocs/com/amazon/carbonado/spi/RAFInputStream.html') diff --git a/apidocs/com/amazon/carbonado/spi/RAFInputStream.html b/apidocs/com/amazon/carbonado/spi/RAFInputStream.html new file mode 100644 index 0000000..915be7b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RAFInputStream.html @@ -0,0 +1,370 @@ + + + + + + +RAFInputStream (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.spi
+

Class RAFInputStream

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class RAFInputStream
    +extends java.io.InputStream
    +
    InputStream that wraps a RandomAccessFile. A stream can be obtained for a + RandomAccessFile by getting the file descriptor and creating a + FileInputStream on it. Problem is that FileInputStream has a finalizer that + closes the RandomAccessFile.
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      RAFInputStream(java.io.RandomAccessFile raf) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      intread() 
      intread(byte[] b) 
      intread(byte[] b, + int offset, + int length) 
      longskip(long n) 
      +
        +
      • + + +

        Methods inherited from class java.io.InputStream

        +available, mark, markSupported, reset
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RAFInputStream

        +
        public RAFInputStream(java.io.RandomAccessFile raf)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        read

        +
        public int read()
        +         throws java.io.IOException
        +
        +
        Specified by:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
      • +
      + + + +
        +
      • +

        read

        +
        public int read(byte[] b)
        +         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
      • +
      + + + +
        +
      • +

        read

        +
        public int read(byte[] b,
        +       int offset,
        +       int length)
        +         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
      • +
      + + + +
        +
      • +

        skip

        +
        public long skip(long n)
        +          throws java.io.IOException
        +
        +
        Overrides:
        +
        skip in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
      • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3