sample/java.util.zip.CheckedInputStream.txt

   1 *java.util.zip.CheckedInputStream* *CheckedInputStream* An input stream that als
   2
   3 public class CheckedInputStream
   4   extends    |java.io.FilterInputStream|
   5
   6 |java.util.zip.CheckedInputStream_Description|
   7 |java.util.zip.CheckedInputStream_Fields|
   8 |java.util.zip.CheckedInputStream_Constructors|
   9 |java.util.zip.CheckedInputStream_Methods|
  10
  11 ================================================================================
  12
  13 *java.util.zip.CheckedInputStream_Constructors*
  14 |java.util.zip.CheckedInputStream(InputStream,Checksum)|Creates an input stream
  15
  16 *java.util.zip.CheckedInputStream_Methods*
  17 |java.util.zip.CheckedInputStream.getChecksum()|Returns the Checksum for this i
  18 |java.util.zip.CheckedInputStream.read()|Reads a byte.
  19 |java.util.zip.CheckedInputStream.read(byte[],int,int)|Reads into an array of b
  20 |java.util.zip.CheckedInputStream.skip(long)|Skips specified number of bytes of
  21
  22 *java.util.zip.CheckedInputStream_Description*
  23
  24 An input stream that also maintains a checksum of the data being read. The
  25 checksum can then be used to verify the integrity of the input data.
  26
  27
  28 *java.util.zip.CheckedInputStream(InputStream,Checksum)*
  29
  30 public CheckedInputStream(
  31   java.io.InputStream in,
  32   java.util.zip.Checksum cksum)
  33
  34 Creates an input stream using the specified Checksum.
  35
  36     in - the input stream
  37     cksum - the Checksum
  38
  39 *java.util.zip.CheckedInputStream.getChecksum()*
  40
  41 public |java.util.zip.Checksum| getChecksum()
  42
  43 Returns the Checksum for this input stream.
  44
  45
  46     Returns: the Checksum value
  47 *java.util.zip.CheckedInputStream.read()*
  48
  49 public int read()
  50   throws |java.io.IOException|
  51
  52 Reads a byte. Will block if no input is available.
  53
  54
  55     Returns: the byte read, or -1 if the end of the stream is reached.
  56 *java.util.zip.CheckedInputStream.read(byte[],int,int)*
  57
  58 public int read(
  59   byte[] buf,
  60   int off,
  61   int len)
  62   throws |java.io.IOException|
  63
  64 Reads into an array of bytes. Will block until some input is available.
  65
  66     buf - the buffer into which the data is read
  67     off - the start offset of the data
  68     len - the maximum number of bytes read
  69
  70     Returns: the actual number of bytes read, or -1 if the end of the stream is reached.
  71 *java.util.zip.CheckedInputStream.skip(long)*
  72
  73 public long skip(long n)
  74   throws |java.io.IOException|
  75
  76 Skips specified number of bytes of input.
  77
  78     n - the number of bytes to skip
  79
  80     Returns: the actual number of bytes skipped
  81