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
void	mark(int readlimit)
boolean	markSupported()	Marking is not supported, as the match state can't be restored
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)	Skips by reading, so that the skipped bytes go through the replacement
String	toString()

Methods inherited from class java.io.FilterInputStream

available, close

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, wait, wait, wait

Constructor Details

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 Details

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

skip

public long skip(long n)
          throws IOException

Skips by reading, so that the skipped bytes go through the replacement

Overrides:

skip in class FilterInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Marking is not supported, as the match state can't be restored

Overrides:

markSupported in class FilterInputStream

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object