org.springframework.boot.buildpack.platform.io

Class InspectedContent

java.lang.Object

org.springframework.boot.buildpack.platform.io.InspectedContent

All Implemented Interfaces:

Content

public class InspectedContent
extends Object
implements Content

Content that is reads and inspects a source of data only once but allows it to be consumed multiple times.

Since:

2.3.0

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InspectedContent.Inspector Interface that can be used to inspect content as it is initially read.

Method Summary

Modifier and Type	Method and Description
static InspectedContent	of(Content content, InspectedContent.Inspector... inspectors) Factory method to create an InspectedContent instance from source content.
static InspectedContent	of(InputStream inputStream, InspectedContent.Inspector... inspectors) Factory method to create an InspectedContent instance from a source input stream.
static InspectedContent	of(IOConsumer<OutputStream> writer, InspectedContent.Inspector... inspectors) Factory method to create an InspectedContent instance from a source write method.
int	size() The size of the content in bytes.
void	writeTo(OutputStream outputStream) Write the content to the given output stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.buildpack.platform.io.Content

of, of, of, of

Method Detail

size

public int size()

Description copied from interface: Content

The size of the content in bytes.

Specified by:

size in interface Content

Returns:

the content size

writeTo

public void writeTo(OutputStream outputStream)
             throws IOException

Description copied from interface: Content

Write the content to the given output stream.

Specified by:

writeTo in interface Content

Parameters:

outputStream - the output stream to write to

Throws:

IOException - on IO error

of

public static InspectedContent of(InputStream inputStream,
                                  InspectedContent.Inspector... inspectors)
                           throws IOException

Factory method to create an InspectedContent instance from a source input stream.

Parameters:

inputStream - the content input stream

inspectors - any inspectors to apply

Returns:

a new inspected content instance

Throws:

IOException - on IO error

of

public static InspectedContent of(Content content,
                                  InspectedContent.Inspector... inspectors)
                           throws IOException

Factory method to create an InspectedContent instance from source content.

Parameters:

content - the content

inspectors - any inspectors to apply

Returns:

a new inspected content instance

Throws:

IOException - on IO error

of

public static InspectedContent of(IOConsumer<OutputStream> writer,
                                  InspectedContent.Inspector... inspectors)
                           throws IOException

Factory method to create an InspectedContent instance from a source write method.

Parameters:

writer - a consumer representing the write method

inspectors - any inspectors to apply

Returns:

a new inspected content instance

Throws:

IOException - on IO error