Package com.io7m.smfj.format.text
Class SMFFormatText
- java.lang.Object
-
- com.io7m.smfj.format.text.SMFFormatText
-
- All Implemented Interfaces:
SMFParserProviderType
,SMFVersionProbeProviderType
,SMFSerializerProviderType
public final class SMFFormatText extends java.lang.Object implements SMFParserProviderType, SMFSerializerProviderType, SMFVersionProbeProviderType
The implementation of the text format.
-
-
Constructor Summary
Constructors Constructor Description SMFFormatText()
Construct a text format provider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SMFParserRandomAccessType
parserCreateRandomAccess(SMFParserEventsType events, java.net.URI uri, java.nio.channels.FileChannel file)
SMFParserSequentialType
parserCreateSequential(SMFParserEventsType in_events, java.net.URI in_uri, java.io.InputStream in_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()
java.lang.String
toString()
-
-
-
Method Detail
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
parserFormat
public SMFFormatDescription parserFormat()
- Specified by:
parserFormat
in interfaceSMFParserProviderType
- Returns:
- The format that this provider supports
-
parserSupportedVersions
public java.util.SortedSet<SMFFormatVersion> parserSupportedVersions()
- Specified by:
parserSupportedVersions
in interfaceSMFParserProviderType
- Returns:
- The supported versions of the format
-
parserCreateSequential
public SMFParserSequentialType parserCreateSequential(SMFParserEventsType in_events, java.net.URI in_uri, java.io.InputStream in_stream)
- Specified by:
parserCreateSequential
in interfaceSMFParserProviderType
- Parameters:
in_events
- The event receiverin_uri
- The URI referred to by the input stream, for diagnostic messagesin_stream
- An input stream- Returns:
- A new parser for the format
- 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 interfaceSMFParserProviderType
- Parameters:
events
- The event receiveruri
- The URI referred to by the input stream, for diagnostic messagesfile
- 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()
-
serializerFormat
public SMFFormatDescription serializerFormat()
- Specified by:
serializerFormat
in interfaceSMFSerializerProviderType
- Returns:
- The format that this provider supports
-
serializerSupportedVersions
public java.util.SortedSet<SMFFormatVersion> serializerSupportedVersions()
- Specified by:
serializerSupportedVersions
in interfaceSMFSerializerProviderType
- 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
- Specified by:
serializerCreate
in interfaceSMFSerializerProviderType
- Parameters:
version
- The format versionuri
- The URI referred to by the output stream, for diagnostic messagesstream
- An output stream- Returns:
- A new serializer for the format
- Throws:
java.lang.UnsupportedOperationException
- If the given version is not supported
-
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 interfaceSMFVersionProbeProviderType
- Parameters:
stream
- The stream- Returns:
- A probed version or a list of errors
-
-