Package com.io7m.changelog.xml.api

Interface CXMLChangelogWriterProviderType

All Superinterfaces:

CChangelogWriterProviderType

All Known Implementing Classes:

CXMLChangelogWriters

public interface CXMLChangelogWriterProviderType
extends CChangelogWriterProviderType

The type of writer providers.

Method Summary

Modifier and Type	Method	Description
CXMLChangelogWriterType	create(URI uri, OutputStream stream)	Create a new writer.
default void	write(Path file, Path fileTemp, CChangelog changelog)	Create a new writer, write the contents of changelog to fileTemp and then atomically rename fileTemp to file.

Method Details

create

CXMLChangelogWriterType 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

write

default void write(Path file,
 Path fileTemp,
 CChangelog changelog)
            throws IOException

Create a new writer, write the contents of changelog to fileTemp and then atomically rename fileTemp to file.

Parameters:

file - The output file

fileTemp - The temporary output file

changelog - The changelog

Throws:

IOException - On I/O errors