Package com.cloudbees.jenkins.support.filter

Class FilteredInputStream

java.lang.Object

java.io.InputStream

com.cloudbees.jenkins.support.filter.FilteredInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class FilteredInputStream
extends InputStream

A custom InputStream that filters lines of text read from an underlying InputStream using a provided mapping function. Each line read from the input stream is processed by the function before being returned, allowing for modifications such as redaction or transformation of the line content.

Author:

Basil Crow

Constructor Summary

Constructors

Constructor	Description
FilteredInputStream(InputStream is, Charset encoding, Function<String,String> filter)	Constructs a filtered stream using the provided filter and encoding.

Method Summary

Modifier and Type	Method	Description
void	close()
int	read()

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

FilteredInputStream

public FilteredInputStream(@NonNull
 InputStream is,
 @NonNull
 Charset encoding,
 @NonNull
 Function<String,String> filter)

Constructs a filtered stream using the provided filter and encoding.

Parameters:

is - Input stream to read line content from

encoding - Character set to use for decoding and encoding bytes read from this stream

filter - Filter to apply to lines read from this stream

Method Details

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException