Package com.io7m.changelog.xml.api

Interface CXMLChangelogParserProviderType

All Superinterfaces:

CChangelogParserProviderType

All Known Implementing Classes:

CXMLChangelogParsers

public interface CXMLChangelogParserProviderType
extends CChangelogParserProviderType

The type of parser providers.

Method Summary

Modifier and Type	Method	Description
CXMLChangelogParserType	create(URI uri, InputStream stream, Consumer<CParseError> receiver)	Create a new parser.
default CChangelog	parse(Path file, Consumer<CParseError> receiver)	Parse a changelog from the given file.

Method Details

create

CXMLChangelogParserType create(URI uri,
 InputStream stream,
 Consumer<CParseError> receiver)
                        throws IOException

Description copied from interface: CChangelogParserProviderType

Create a new parser.

Specified by:

create in interface CChangelogParserProviderType

Parameters:

uri - The URI of the stream, for diagnostic messages

stream - The stream

receiver - A receiver for errors

Returns:

A new parser

Throws:

IOException - On I/O errors

parse

default CChangelog parse(Path file,
 Consumer<CParseError> receiver)
                  throws IOException

Parse a changelog from the given file.

Parameters:

file - The file

receiver - An error receiver

Returns:

A parsed changelog

Throws:

IOException - On I/O errors