BoundedInputStream (The Adobe AEM Quickstart and Web Application.)

java.lang.Object
- java.io.InputStream
- - java.io.FilterInputStream
  - - org.apache.commons.io.input.ProxyInputStream
    - - org.apache.commons.io.input.BoundedInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

BoundedInputStream
```
public class BoundedInputStream
extends ProxyInputStream
```
Reads bytes up to a maximum count and stops once reached.
To build an instance: Use the builder() to access all features.

By default, a BoundedInputStream is unbound; so make sure to call AbstractBuilder#setMaxCount(long).

You can find out how many bytes this stream has seen so far by calling getCount(). This value reflects bytes read and skipped.

Using a ServletInputStream

A ServletInputStream can block if you try to read content that isn't there because it doesn't know whether the content hasn't arrived yet or whether the content has finished. Initialize an BoundedInputStream with the Content-Length sent in the ServletInputStream's header, this stop it from blocking, providing it's been sent with a correct content length in the first place.

Using NIO
```
 BoundedInputStream s = BoundedInputStream.builder()
   .setPath(Paths.get("MyFile.xml"))
   .setMaxCount(1024)
   .setPropagateClose(false)
   .get();
 
 
```
Using IO
```
 BoundedInputStream s = BoundedInputStream.builder()
   .setFile(new File("MyFile.xml"))
   .setMaxCount(1024)
   .setPropagateClose(false)
   .get();
 
 
```
Counting Bytes

You can set the running count when building, which is most useful when starting from another stream:
```
 InputStream in = ...;
 BoundedInputStream s = BoundedInputStream.builder()
   .setInputStream(in)
   .setCount(12)
   .setMaxCount(1024)
   .setPropagateClose(false)
   .get();
 
 
```
Listening for the max count reached
```
 BoundedInputStream s = BoundedInputStream.builder()
   .setPath(Paths.get("MyFile.xml"))
   .setMaxCount(1024)
   .setOnMaxCount((max, count) -> System.out.printf("Max count %,d reached with a last read count of %,d%n", max, count))
   .get();
 
 
```
Since:

2.0

See Also:

BoundedInputStream.Builder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BoundedInputStream.Builder
Builds a new BoundedInputStream.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BoundedInputStream.Builder` Builds a new `BoundedInputStream`.

Constructor Summary

Constructors
Constructor and Description
`BoundedInputStream(java.io.InputStream in)` Deprecated. Use `AbstractBuilder#get()`.
`BoundedInputStream(java.io.InputStream inputStream, long maxCount)` Deprecated. Use `AbstractBuilder#get()`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`available()` Invokes the delegate's `InputStream.available()` method.
`static BoundedInputStream.Builder`	`builder()` Constructs a new `AbstractBuilder`.
`void`	`close()` Invokes the delegate's `InputStream.close()` method if `isPropagateClose()` is `true`.
`long`	`getCount()` Gets the count of bytes read.
`long`	`getMaxCount()` Gets the max count of bytes to read.
`long`	`getMaxLength()` Deprecated. Use `getMaxCount()`.
`long`	`getRemaining()` Gets how many bytes remain to read.
`boolean`	`isPropagateClose()` Tests whether the `close()` method should propagate to the underling `InputStream`.
`void`	`mark(int readLimit)` Invokes the delegate's `InputStream.mark(int)` method.
`boolean`	`markSupported()` Invokes the delegate's `InputStream.markSupported()` method.
`int`	`read()` Invokes the delegate's `InputStream.read()` method if the current position is less than the limit.
`int`	`read(byte[] b)` Invokes the delegate's `InputStream.read(byte[])` method.
`int`	`read(byte[] b, int off, int len)` Invokes the delegate's `InputStream.read(byte[], int, int)` method.
`void`	`reset()` Invokes the delegate's `InputStream.reset()` method.
`void`	`setPropagateClose(boolean propagateClose)` Deprecated. Use `AbstractBuilder#setPropagateClose(boolean)`.
`long`	`skip(long n)` Invokes the delegate's `InputStream.skip(long)` method.
`java.lang.String`	`toString()` Invokes the delegate's `Object.toString()` method.

Methods inherited from class org.apache.commons.io.input.ProxyInputStream
setReference, unwrap

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

- Constructor Detail
  - BoundedInputStream
```
@Deprecated
public BoundedInputStream(java.io.InputStream in)
```
    Deprecated. Use AbstractBuilder#get().
    
    Constructs a new BoundedInputStream that wraps the given input stream and is unbounded.
    To build an instance: Use the builder() to access all features.
    
    Parameters:
    
    in - The wrapped input stream.
  - BoundedInputStream
```
@Deprecated
public BoundedInputStream(java.io.InputStream inputStream,
                                      long maxCount)
```
    Deprecated. Use AbstractBuilder#get().
    
    Constructs a new BoundedInputStream that wraps the given input stream and limits it to a certain size.
    
    Parameters:
    
    inputStream - The wrapped input stream.
    
    maxCount - The maximum number of bytes to return, negative means unbound.
- Method Detail
  - builder
```
public static BoundedInputStream.Builder builder()
```
    Constructs a new AbstractBuilder.
    
    Returns:
    
    a new AbstractBuilder.
    
    Since:
    
    2.16.0
  - available
```
public int available()
              throws java.io.IOException
```
    Invokes the delegate's InputStream.available() method.
    
    Overrides:
    
    available in class ProxyInputStream
    
    Returns:
    
    the number of available bytes, 0 if the stream is closed.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - close
```
public void close()
           throws java.io.IOException
```
    Invokes the delegate's InputStream.close() method if isPropagateClose() is true.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class ProxyInputStream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - getCount
```
public long getCount()
```
    Gets the count of bytes read.
    
    Returns:
    
    The count of bytes read.
    
    Since:
    
    2.12.0
  - getMaxCount
```
public long getMaxCount()
```
    Gets the max count of bytes to read.
    
    Returns:
    
    The max count of bytes to read.
    
    Since:
    
    2.16.0
  - getMaxLength
```
@Deprecated
public long getMaxLength()
```
    Deprecated. Use getMaxCount().
    
    Gets the max count of bytes to read.
    
    Returns:
    
    The max count of bytes to read.
    
    Since:
    
    2.12.0
  - getRemaining
```
public long getRemaining()
```
    Gets how many bytes remain to read.
    
    Returns:
    
    bytes how many bytes remain to read.
    
    Since:
    
    2.16.0
  - isPropagateClose
```
public boolean isPropagateClose()
```
    Tests whether the close() method should propagate to the underling InputStream.
    
    Returns:
    
    true if calling close() propagates to the close() method of the underlying stream or false if it does not.
  - mark
```
public void mark(int readLimit)
```
    Invokes the delegate's InputStream.mark(int) method.
    
    Overrides:
    
    mark in class ProxyInputStream
    
    Parameters:
    
    readLimit - read ahead limit
  - markSupported
```
public boolean markSupported()
```
    Invokes the delegate's InputStream.markSupported() method.
    
    Overrides:
    
    markSupported in class ProxyInputStream
    
    Returns:
    
    true if mark is supported, otherwise false
    
    See Also:
    
    ProxyInputStream.mark(int), ProxyInputStream.reset()
  - read
```
public int read()
         throws java.io.IOException
```
    Invokes the delegate's InputStream.read() method if the current position is less than the limit.
    
    Overrides:
    
    read in class ProxyInputStream
    
    Returns:
    
    the byte read or -1 if the end of stream or the limit has been reached.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - read
```
public int read(byte[] b)
         throws java.io.IOException
```
    Invokes the delegate's InputStream.read(byte[]) method.
    
    Overrides:
    
    read in class ProxyInputStream
    
    Parameters:
    
    b - the buffer to read the bytes into
    
    Returns:
    
    the number of bytes read or -1 if the end of stream or the limit has been reached.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - read
```
public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException
```
    Invokes the delegate's InputStream.read(byte[], int, int) method.
    
    Overrides:
    
    read in class ProxyInputStream
    
    Parameters:
    
    b - the buffer to read the bytes into
    
    off - The start offset
    
    len - The number of bytes to read
    
    Returns:
    
    the number of bytes read or -1 if the end of stream or the limit has been reached.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - reset
```
public void reset()
           throws java.io.IOException
```
    Invokes the delegate's InputStream.reset() method.
    
    Overrides:
    
    reset in class ProxyInputStream
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - setPropagateClose
```
@Deprecated
public void setPropagateClose(boolean propagateClose)
```
    Deprecated. Use AbstractBuilder#setPropagateClose(boolean).
    
    Sets whether the close() method should propagate to the underling InputStream.
    
    Parameters:
    
    propagateClose - true if calling close() propagates to the close() method of the underlying stream or false if it does not.
  - skip
```
public long skip(long n)
          throws java.io.IOException
```
    Invokes the delegate's InputStream.skip(long) method.
    
    Overrides:
    
    skip in class ProxyInputStream
    
    Parameters:
    
    n - the number of bytes to skip
    
    Returns:
    
    the actual number of bytes skipped
    
    Throws:
    
    java.io.IOException - if an I/O error occurs.
  - toString
```
public java.lang.String toString()
```
    Invokes the delegate's Object.toString() method.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the delegate's Object.toString()

Class BoundedInputStream

Using a ServletInputStream

Using NIO

Using IO

Counting Bytes

Listening for the max count reached

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

Methods inherited from class java.lang.Object

Constructor Detail

BoundedInputStream

BoundedInputStream

Method Detail

builder

available

close

getCount

getMaxCount

getMaxLength

getRemaining

isPropagateClose

mark

markSupported

read

read

read

reset

setPropagateClose

skip

toString