org.springframework.boot.test.system

Interface CapturedOutput

All Superinterfaces:

CharSequence

All Known Implementing Classes:

OutputCaptureRule

public interface CapturedOutput
extends CharSequence

Provides access to System.out and System.err output that has been captured by the OutputCaptureExtension or OutputCaptureRule. Can be used to apply assertions either using AssertJ or standard JUnit assertions. For example:

 assertThat(output).contains("started"); // Checks all output
 assertThat(output.getErr()).contains("failed"); // Only checks System.err
 assertThat(output.getOut()).contains("ok"); // Only checks System.out
 

Since:

2.2.0

Author:

Madhura Bhave, Phillip Webb, Andy Wilkinson

See Also:

OutputCaptureExtension

Method Summary

Modifier and Type	Method and Description
default char	charAt(int index)
String	getAll() Return all content (both System.out and System.err) in the order that it was captured.
String	getErr() Return System.err content in the order that it was captured.
String	getOut() Return System.out content in the order that it was captured.
default int	length()
default CharSequence	subSequence(int start, int end)

Methods inherited from interface java.lang.CharSequence

chars, codePoints, toString

Method Detail

length

default int length()

Specified by:

length in interface CharSequence

charAt

default char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

default CharSequence subSequence(int start,
                                 int end)

Specified by:

subSequence in interface CharSequence

getAll

String getAll()

Return all content (both System.out and System.err) in the order that it was captured.

Returns:

all captured output

getOut

String getOut()

Return System.out content in the order that it was captured.

Returns:

System.out captured output

getErr

String getErr()

Return System.err content in the order that it was captured.

Returns:

System.err captured output