net.kemitix.wrapper.printstream

Interface PrintStreamWrapper

All Superinterfaces:

net.kemitix.wrapper.Wrapper<PrintStream>

public interface PrintStreamWrapper
extends net.kemitix.wrapper.Wrapper<PrintStream>

Wrapper for handling PrintStream.

Provides access to the PrintStream.write(int) and PrintStream.write(byte[], int, int) through the Wrapper.

Author:

Paul Campbell (pcampbell@kemitix.net)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PrintStreamWrapper.ByteFilter A Function for filtering a Byte.
static interface	PrintStreamWrapper.ByteTransform A Function for transforming one Byte into another.
static interface	PrintStreamWrapper.StringFilter A Function for filtering a String.
static interface	PrintStreamWrapper.StringTransform A Function for transforming one String into another.

Method Summary

Modifier and Type	Method and Description
static PrintStream	copy(PrintStream left, PrintStream right) Creates a PrintStream that copies PrintStream.write(int) and PrintStream.write(byte[], int, int) calls to both the left and the right PrintStreams.
static PrintStream	filter(PrintStream printStream, PrintStreamWrapper.ByteFilter filter) Create a Byte filtering PrintStream that will filter using the predicate.
static PrintStream	filter(PrintStream printStream, PrintStreamWrapper.StringFilter filter) Create a String filtering PrintStream that will filter using the predicate.
default PrintStream	printStreamDelegate() The content of the PrintStreamWrapper as a PrintStream.
static PrintStream	transform(PrintStream original, PrintStreamWrapper.ByteTransform transformer) Creates a PrintStream that transforms calls the PrintStream.print(String) using the transformer before passing it on to the original.
static PrintStream	transform(PrintStream original, PrintStreamWrapper.StringTransform transformer) Creates a PrintStream that transforms calls the PrintStream.print(String) using the transformer before passing it on to the original.
static Optional<net.kemitix.wrapper.Wrapper<PrintStream>>	unwrap(PrintStream printStream) Get the wrapped PrintStream, if one exists.
void	write(byte[] buf, int off, int len) Writes len bytes from the specified byte array starting at offset off to this stream.
void	write(int b) Writes the specified byte to this stream.

Methods inherited from interface net.kemitix.wrapper.Wrapper

getInnerWrapper, getWrapperSubject, wrap, wrap

Method Detail

filter

static PrintStream filter(PrintStream printStream,
                          PrintStreamWrapper.StringFilter filter)

Create a String filtering PrintStream that will filter using the predicate.

Parameters:

printStream - the PrintStream to received filtered writes

filter - the String filter

Returns:

A String filtering PrintStream

filter

static PrintStream filter(PrintStream printStream,
                          PrintStreamWrapper.ByteFilter filter)

Create a Byte filtering PrintStream that will filter using the predicate.

Parameters:

printStream - the PrintStream to received filtered writes

filter - the Byte filter

Returns:

A Byte filtering PrintStream

unwrap

static Optional<net.kemitix.wrapper.Wrapper<PrintStream>> unwrap(PrintStream printStream)

Get the wrapped PrintStream, if one exists.

Parameters:

printStream - the PrintStream to unwrap

Returns:

An Optional containing the wrapped PrintStream, or empty if there is none

copy

static PrintStream copy(PrintStream left,
                        PrintStream right)

Creates a PrintStream that copies PrintStream.write(int) and PrintStream.write(byte[], int, int) calls to both the left and the right PrintStreams.

Parameters:

left - the first PrintStream

right - the second PrintStream

Returns:

A Copying PrintStream

transform

static PrintStream transform(PrintStream original,
                             PrintStreamWrapper.StringTransform transformer)

Creates a PrintStream that transforms calls the PrintStream.print(String) using the transformer before passing it on to the original.

Parameters:

original - the PrintStream to receive the transformed calls

transformer - the String transformer

Returns:

A String transforming PrintStream

transform

static PrintStream transform(PrintStream original,
                             PrintStreamWrapper.ByteTransform transformer)

Creates a PrintStream that transforms calls the PrintStream.print(String) using the transformer before passing it on to the original.

Parameters:

original - the PrintStream to receive the transformed calls

transformer - the Byte transformer

Returns:

A Byte transforming PrintStream

printStreamDelegate

default PrintStream printStreamDelegate()

The content of the PrintStreamWrapper as a PrintStream.

Returns:

The content of the PrintStreamWrapper as a PrintStream

write

void write(int b)

Writes the specified byte to this stream.

If the byte is a newline and automatic flushing is enabled then the flush method will be invoked.

Note that the byte is written as given; to write a character that will be translated according to the platform's default character encoding, use the print(char) or println(char) methods.

This implementation passes the byte, unmodified, to the intercepted PrintStream or Wrapper<PrintStream>.

Parameters:

b - The byte to be written

See Also:

PrintStream.print(char), PrintStream.println(char)

write

void write(byte[] buf,
           int off,
           int len)

Writes len bytes from the specified byte array starting at offset off to this stream.

If automatic flushing is enabled then the flush method will be invoked.

Note that the bytes will be written as given; to write characters that will be translated according to the platform's default character encoding, use the print(char) or println(char) methods.

This implementation passes the bytes, unmodified, to the intercepted PrintStream or Wrapper<PrintStream>.

Parameters:

buf - A byte array

off - Offset from which to start taking bytes

len - Number of bytes to write