Package com.io7m.smfj.format.xml

Class SMFFormatXML

java.lang.Object

com.io7m.smfj.format.xml.SMFFormatXML

All Implemented Interfaces:

SMFParserProviderType, SMFVersionProbeProviderType, SMFSerializerProviderType

public final class SMFFormatXML
extends java.lang.Object
implements SMFParserProviderType, SMFSerializerProviderType, SMFVersionProbeProviderType

A format provider for the XML format.

Constructor Summary

Constructors

Constructor	Description
SMFFormatXML()	Construct a format provider.

Method Summary

Modifier and Type	Method	Description
SMFParserRandomAccessType	parserCreateRandomAccess(SMFParserEventsType events, java.net.URI uri, java.nio.channels.FileChannel file)
SMFParserSequentialType	parserCreateSequential(SMFParserEventsType events, java.net.URI uri, java.io.InputStream stream)
SMFFormatDescription	parserFormat()
java.util.SortedSet<SMFFormatVersion>	parserSupportedVersions()
SMFPartialLogged<SMFVersionProbed>	probe(java.io.InputStream stream)	Attempt to probe the given file stream.
SMFSerializerType	serializerCreate(SMFFormatVersion version, java.net.URI uri, java.io.OutputStream stream)
SMFFormatDescription	serializerFormat()
java.util.SortedSet<SMFFormatVersion>	serializerSupportedVersions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SMFFormatXML

public SMFFormatXML()

Construct a format provider.

Method Detail

parserFormat

public SMFFormatDescription parserFormat()

Specified by:

parserFormat in interface SMFParserProviderType

Returns:

The format that this provider supports

parserSupportedVersions

public java.util.SortedSet<SMFFormatVersion> parserSupportedVersions()

Specified by:

parserSupportedVersions in interface SMFParserProviderType

Returns:

The supported versions of the format

parserCreateSequential

public SMFParserSequentialType parserCreateSequential(SMFParserEventsType events,
                                                      java.net.URI uri,
                                                      java.io.InputStream stream)
                                               throws java.lang.UnsupportedOperationException

Specified by:

parserCreateSequential in interface SMFParserProviderType

Parameters:

events - The event receiver

uri - The URI referred to by the input stream, for diagnostic messages

stream - An input stream

Returns:

A new parser for the format

Throws:

java.lang.UnsupportedOperationException - If sequential parsing is not supported

See Also:

SMFFormatDescription.randomAccess()

parserCreateRandomAccess

public SMFParserRandomAccessType parserCreateRandomAccess(SMFParserEventsType events,
                                                          java.net.URI uri,
                                                          java.nio.channels.FileChannel file)
                                                   throws java.lang.UnsupportedOperationException

Specified by:

parserCreateRandomAccess in interface SMFParserProviderType

Parameters:

events - The event receiver

uri - The URI referred to by the input stream, for diagnostic messages

file - A file channel

Returns:

A new parser for the format

Throws:

java.lang.UnsupportedOperationException - If random-access parsing is not supported

See Also:

SMFFormatDescription.randomAccess()

probe

public SMFPartialLogged<SMFVersionProbed> probe(java.io.InputStream stream)

Description copied from interface: SMFVersionProbeProviderType

Attempt to probe the given file stream.

Specified by:

probe in interface SMFVersionProbeProviderType

Parameters:

stream - The stream

Returns:

A probed version or a list of errors

serializerFormat

public SMFFormatDescription serializerFormat()

Specified by:

serializerFormat in interface SMFSerializerProviderType

Returns:

The format that this provider supports

serializerSupportedVersions

public java.util.SortedSet<SMFFormatVersion> serializerSupportedVersions()

Specified by:

serializerSupportedVersions in interface SMFSerializerProviderType

Returns:

The supported versions of the format

serializerCreate

public SMFSerializerType serializerCreate(SMFFormatVersion version,
                                          java.net.URI uri,
                                          java.io.OutputStream stream)
                                   throws java.lang.UnsupportedOperationException,
                                          java.io.IOException

Specified by:

serializerCreate in interface SMFSerializerProviderType

Parameters:

version - The format version

uri - The URI referred to by the output stream, for diagnostic messages

stream - An output stream

Returns:

A new serializer for the format

Throws:

java.lang.UnsupportedOperationException - If the given version is not supported

java.io.IOException - On I/O errors