Package org.apache.poi.util

Class ReplacingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.poi.util.ReplacingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@Internal
public class ReplacingInputStream
extends FilterInputStream

Simple FilterInputStream that can replace occurrences of bytes with something else. This has been taken from inbot-utils. (MIT licensed)

See Also:

inbot-utils

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
ReplacingInputStream(InputStream in, byte[] pattern, byte[] replacement)	Replace occurrences of pattern in the input.
ReplacingInputStream(InputStream in, String pattern, String replacement)	Replace occurrences of pattern in the input.

Method Summary

Modifier and Type	Method	Description
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
String	toString()

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, reset, skip

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReplacingInputStream

public ReplacingInputStream(InputStream in,
                            String pattern,
                            String replacement)

Replace occurrences of pattern in the input. Note: input is assumed to be UTF-8 encoded. If not the case use byte[] based pattern and replacement.

Parameters:

in - input

pattern - pattern to replace.

replacement - the replacement or null

ReplacingInputStream

public ReplacingInputStream(InputStream in,
                            byte[] pattern,
                            byte[] replacement)

Replace occurrences of pattern in the input.

If you want to normalize line endings DOS/MAC (\n\r | \r) to UNIX (\n), you can call the following:
new ReplacingInputStream(new ReplacingInputStream(is, "\n\r", "\n"), "\r", "\n")

Parameters:

in - input

pattern - pattern to replace

replacement - the replacement or null

Method Detail

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object