com.io7m.smfj.format.text.v1

## Class SMFTV1HeaderCommandSchema

- java.lang.Object
- - com.io7m.smfj.format.text.v1.SMFTV1HeaderCommandSchema

- All Implemented Interfaces:
    SMFTHeaderCommandParserType

      public final class SMFTV1HeaderCommandSchema
      extends Object
      implements SMFTHeaderCommandParserType

  A parser for the "schema" command.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `SYNTAX` The command syntax.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SMFTV1HeaderCommandSchema(SMFTLineReaderType in_reader, SMFHeader.Builder in_header)` Construct a parser.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `name()`
    `SMFTParsingStatus` | `parse(SMFParserEventsHeaderType receiver, javaslang.collection.List<String> line)` Parse the section, delivering events to `receiver`.

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### SYNTAX

          public static final String SYNTAX

      The command syntax.
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### SMFTV1HeaderCommandSchema

          public SMFTV1HeaderCommandSchema(SMFTLineReaderType in_reader,
                                           SMFHeader.Builder in_header)

      Construct a parser.
      Parameters:
        `in_reader` - The current line reader
        `in_header` - A header builder

  - ### Method Detail

    - #### name

          public String name()

      Specified by:
        `name` in interface `SMFTHeaderCommandParserType`
      Returns:
        The name of the header command

    - #### parse

          public SMFTParsingStatus parse(SMFParserEventsHeaderType receiver,
                                         javaslang.collection.List<String> line)
                                  throws IOException

      Description copied from interface: `SMFTHeaderCommandParserType`
      Parse the section, delivering events to `receiver`.
      Specified by:
        `parse` in interface `SMFTHeaderCommandParserType`
      Parameters:
        `receiver` - The event receiver
        `line` - The current line
      Returns:
        The result of parsing
      Throws:
        `IOException` - On I/O errors

Copyright © 2017 <code@io7m.com> http://io7m.com