Package com.io7m.changelog.xml.api

Interface CAtomChangelogWriterProviderType

All Superinterfaces:

CChangelogWriterProviderType

All Known Implementing Classes:

CAtomChangelogWriters

public interface CAtomChangelogWriterProviderType
extends CChangelogWriterProviderType

The type of Atom writer providers.

Method Summary

Modifier and Type	Method	Description
default CChangelogWriterType	create(java.net.URI uri, java.io.OutputStream stream)	Create a new writer.
CAtomChangelogWriterType	createWithConfiguration(CAtomChangelogWriterConfiguration configuration, java.net.URI uri, java.io.OutputStream stream)	Create a writer with the given configuration.

Method Detail

create

default CChangelogWriterType create(java.net.URI uri,
                                    java.io.OutputStream stream)
                             throws java.io.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:

java.io.IOException - On I/O errors

createWithConfiguration

CAtomChangelogWriterType createWithConfiguration(CAtomChangelogWriterConfiguration configuration,
                                                 java.net.URI uri,
                                                 java.io.OutputStream stream)
                                          throws java.io.IOException

Create a writer with the given configuration.

Parameters:

configuration - The atom feed configuration

uri - The output URI, for diagnostic purposes

stream - The output stream

Returns:

A writer

Throws:

java.io.IOException - On I/O errors