io.micronaut.core.io

Interface Streamable

All Known Subinterfaces:

Writable

All Known Implementing Classes:

ConfigurationMetadata, PropertyMetadata

public interface Streamable

Interface for types that can be written to an OutputStream.

Since:

1.0

Author:

Graeme Rocher

Method Summary

Modifier and Type	Method and Description
default void	writeTo(File file) Write this Writable to the given File.
default void	writeTo(OutputStream outputStream) Write this object to the given OutputStream using StandardCharsets.UTF_8 by default.
void	writeTo(OutputStream outputStream, Charset charset) Write this object to the given OutputStream using StandardCharsets.UTF_8 by default.

Method Detail

writeTo

void writeTo(OutputStream outputStream,
             @Nullable
             Charset charset)
      throws IOException

Write this object to the given OutputStream using StandardCharsets.UTF_8 by default.

Parameters:

outputStream - The output stream

charset - The charset to use. Defaults to StandardCharsets.UTF_8

Throws:

IOException - if an error occurred while outputting data to the writer

writeTo

default void writeTo(File file)
              throws IOException

Write this Writable to the given File.

Parameters:

file - The file

Throws:

IOException - if an error occurred while outputting data to the writer

writeTo

default void writeTo(OutputStream outputStream)
              throws IOException

Write this object to the given OutputStream using StandardCharsets.UTF_8 by default.

Parameters:

outputStream - The output stream

Throws:

IOException - if an error occurred while outputting data to the writer