Package com.io7m.coffeepick.runtime.parser.spi

# Interface SPIParserProviderType

All Known Implementing Classes:
  `FormatXMLSPIParserProvider`

    @ProviderType
    public interface SPIParserProviderType

The type of parser providers.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `SPIParserType` | `parserCreate​(SPIParserRequest request)` |
  `FormatDescription` | `parserFormatSupported()` |
  `java.util.SortedSet<FormatVersion>` | `parserFormatVersionsSupported()` |
  `java.lang.String` | `parserName()` |
  `SPIProbeResultType` | `probe​(SPIParserRequest request)` | Try to probe the format of the given request.

- ## Method Details

  - ### parserFormatSupported

    FormatDescription parserFormatSupported()
    Returns:
      The format that this provider supports

  - ### parserFormatVersionsSupported

    java.util.SortedSet<FormatVersion> parserFormatVersionsSupported()
    Returns:
      The supported versions of the format

  - ### parserName

    java.lang.String parserName()
    Returns:
      The name of this provider

  - ### probe

    SPIProbeResultType probe​(SPIParserRequest request) throws java.io.IOException
    Try to probe the format of the given request.
    Parameters:
      `request` - The request
    Returns:
      The result of probing
    Throws:
      `java.io.IOException` - On I/O errors

  - ### parserCreate

    SPIParserType parserCreate​(SPIParserRequest request) throws java.io.IOException
    Parameters:
      `request` - The parser request
    Returns:
      A new parser for the format
    Throws:
      `java.io.IOException` - On I/O or parser configuration errors