com.twelvemonkeys.io.SubStream

All Implemented Interfaces:: Closeable, AutoCloseable

public final class SubStream extends FilterInputStream

An InputStream reading up to a specified number of bytes from an underlying stream.

Version:: $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/SubStream.java#2 $
Author:: Harald Kuhr

Field Summary

Fields inherited from class java.io.FilterInputStream
in
Constructor Summary

Constructors

Constructor

Description

SubStream(InputStream pStream, long pLength)

Creates a SubStream of the given pStream.
Method Summary

Modifier and Type

Method

Description

int

available()

void

close()

Marks this stream as closed.

void

mark(int pReadLimit)

int

read()

final int

read(byte[] pBytes)

int

read(byte[] pBytes, int pOffset, int pLength)

void

reset()

long

skip(long pLength)

Methods inherited from class java.io.FilterInputStream
markSupported

Methods inherited from class java.io.InputStream
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SubStream
  
  public SubStream(InputStream pStream, long pLength)
  
  Creates a SubStream of the given pStream.
  
  Parameters:
  
  pStream - the underlying input stream
  
  pLength - maximum number of bytes to read drom this stream
Method Details
- close
  
  public void close() throws IOException
  
  Marks this stream as closed. This implementation does not close the underlying stream.
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Closeable
  
  Overrides:
  
  close in class FilterInputStream
  
  Throws:
  
  IOException
- available
  
  public int available() throws IOException
  
  Overrides:
  
  available in class FilterInputStream
  
  Throws:
  
  IOException
- mark
  
  public void mark(int pReadLimit)
  
  Overrides:
  
  mark in class FilterInputStream
- reset
  
  public void reset() throws IOException
  
  Overrides:
  
  reset in class FilterInputStream
  
  Throws:
  
  IOException
- read
  
  public int read() throws IOException
  
  Overrides:
  
  read in class FilterInputStream
  
  Throws:
  
  IOException
- read
  
  public final int read(byte[] pBytes) throws IOException
  
  Overrides:
  
  read in class FilterInputStream
  
  Throws:
  
  IOException
- read
  
  public int read(byte[] pBytes, int pOffset, int pLength) throws IOException
  
  Overrides:
  
  read in class FilterInputStream
  
  Throws:
  
  IOException
- skip
  
  public long skip(long pLength) throws IOException
  
  Overrides:
  
  skip in class FilterInputStream
  
  Throws:
  
  IOException

Class SubStream

Field Summary

Fields inherited from class java.io.FilterInputStream

Constructor Summary

Method Summary

Methods inherited from class java.io.FilterInputStream

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Constructor Details

SubStream

Method Details

close

available

mark

reset

read

read

read

skip