com.day.io.file

Class SizedInputStream

java.lang.Object

java.io.InputStream

com.day.io.file.SizedInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

SizedBlankInputStream

public class SizedInputStream
extends java.io.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(java.io.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)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SizedInputStream

public SizedInputStream(java.io.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 java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

See Also:

InputStream.read()

read

public int read(byte[] b)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

See Also:

InputStream.read(byte[])

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

See Also:

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

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException

See Also:

InputStream.skip(long)

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

See Also:

InputStream.available()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

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

See Also:

InputStream.close()

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

See Also:

InputStream.reset()

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.InputStream

See Also:

InputStream.mark(int)

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

See Also:

InputStream.markSupported()