Module com.io7m.changelog.text.api

Package com.io7m.changelog.text.api

Interface CPlainChangelogWriterProviderType

All Superinterfaces:

CChangelogWriterProviderType

All Known Implementing Classes:

CPlainChangelogWriters

public interface CPlainChangelogWriterProviderType
extends CChangelogWriterProviderType

The type of writer providers.

Method Summary

Modifier and Type	Method	Description
default CPlainChangelogWriterType	create(URI uri, OutputStream stream)	Create a new writer.
CPlainChangelogWriterType	createWithConfiguration(CPlainChangelogWriterConfiguration config, URI uri, OutputStream stream)	Create a writer with the given configuration.

Method Detail

create

default CPlainChangelogWriterType create(URI uri,
                                         OutputStream stream)
                                  throws IOException

Description copied from interface: CChangelogWriterProviderType

Create a new writer.

Specified by:

create in interface CChangelogWriterProviderType

Parameters:

uri - The URI of the stream, for diagnostic messages

stream - The stream

Returns:

A new writer

Throws:

IOException - On I/O errors

createWithConfiguration

CPlainChangelogWriterType createWithConfiguration(CPlainChangelogWriterConfiguration config,
                                                  URI uri,
                                                  OutputStream stream)
                                           throws IOException

Create a writer with the given configuration.

Parameters:

config - The configuration

uri - The URI for diagnostic purposes

stream - The output stream

Returns:

A writer

Throws:

IOException - On I/O errors