com.day.io.file

Class SizedInputStream

java.lang.Object

java.io.InputStream

com.day.io.file.SizedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

SizedBlankInputStream

public class SizedInputStream
extends InputStream

This is a stream that will only supply bytes up to a certain length - if its position goes above that, it will stop.

This is useful to wrap ServletInputStreams. The ServletInputStream will block if you try to read content from it that isn't there, because it doesn't know whether the content hasn't arrived yet or whether the content has finished. So, one of these, initialized with the Content-length sent in the ServletInputStream's header, will stop it blocking, providing it's been sent with a correct content length.

Since:

antbear

Constructor Summary

Constructors

Constructor and Description
SizedInputStream(InputStream in, int size) Creates a new SizedInputStream that wraps the given input stream and limits it to a certain size.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SizedInputStream

public SizedInputStream(InputStream in,
                        int size)

Creates a new SizedInputStream that wraps the given input stream and limits it to a certain size.

Parameters:

in - The wrapped input stream

size - The maximum number of bytes to return

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

See Also:

InputStream.read()

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

See Also:

InputStream.read(byte[])

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

See Also:

InputStream.read(byte[], int, int)

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

See Also:

InputStream.skip(long)

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

See Also:

InputStream.available()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

See Also:

InputStream.close()

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

See Also:

InputStream.reset()

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

See Also:

InputStream.mark(int)

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

See Also:

InputStream.markSupported()