Module com.github.robtimus.junit.support

Package com.github.robtimus.junit.support.test.io

Interface WriterDelegateTests

All Known Subinterfaces:

WriterDelegateTests.AppendCharSequencePortionTests, WriterDelegateTests.AppendCharSequenceTests, WriterDelegateTests.AppendCharTests, WriterDelegateTests.CloseTests, WriterDelegateTests.FlushTests, WriterDelegateTests.WriteCharArrayPortionTests, WriterDelegateTests.WriteCharArrayTests, WriterDelegateTests.WriteCharTests, WriterDelegateTests.WriteStringPortionTests, WriterDelegateTests.WriteStringTests

public interface WriterDelegateTests

Base interface for testing that Writer implementations correctly delegate to another Writer.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WriterDelegateTests.AppendCharSequencePortionTests	Contains tests for Writer.append(CharSequence, int, int).
static interface	WriterDelegateTests.AppendCharSequenceTests	Contains tests for Writer.append(CharSequence).
static interface	WriterDelegateTests.AppendCharTests	Contains tests for Writer.append(char).
static class	WriterDelegateTests.CharSequenceTransformationProvider	An arguments provider for WriterDelegateTests.AppendCharSequenceTests and WriterDelegateTests.AppendCharSequencePortionTests, it returns functions to transform the test instance's content to write or long content to write into a String (identity transform), StringBuilder, StringBuffer and a generic CharSequence.
static interface	WriterDelegateTests.CloseTests	Contains tests for Writer.close().
static interface	WriterDelegateTests.FlushTests	Contains tests for Writer.flush().
static interface	WriterDelegateTests.WriteCharArrayPortionTests	Contains tests for Writer.write(char[], int, int).
static interface	WriterDelegateTests.WriteCharArrayTests	Contains tests for Writer.write(char[]).
static interface	WriterDelegateTests.WriteCharTests	Contains tests for Writer.write(int).
static interface	WriterDelegateTests.WriteStringPortionTests	Contains tests for Writer.write(String, int, int).
static interface	WriterDelegateTests.WriteStringTests	Contains tests for Writer.write(String).

Method Summary

Modifier and Type	Method	Description
default String	contentToWrite()	Returns the content to write for most tests.
String	expectedContent(String written)	Returns the expected content written to a delegate, based on the content that was written to a created writer.
default String	longContentToWrite()	Returns the content to write when testing writing large pieces of text.
Writer	wrapWriter(Writer delegate)	Creates the writer to test.

Method Detail

wrapWriter

Writer wrapWriter(Writer delegate)

Creates the writer to test.

This method will be called only once for each test. This makes it possible to capture the writer to test and its delegate, and perform additional tests after the pre-defined test has finished.

Parameters:

delegate - The delegate to test against.

Returns:

The created writer.

expectedContent

String expectedContent(String written)

Returns the expected content written to a delegate, based on the content that was written to a created writer.

Parameters:

written - The content that was written.

Returns:

The expected content.

contentToWrite

default String contentToWrite()

Returns the content to write for most tests. This default implementation returns a lorem ipsum text.

Returns:

The content to write.

longContentToWrite

default String longContentToWrite()

Returns the content to write when testing writing large pieces of text. this default implementation returns contentToWrite() concatenated 1000 times.

Returns:

The content to write when testing writing large pieces of text.