Package com.io7m.coffeepick.runtime.format.xml

# Class FormatXML1TopLevelHandler

java.lang.Object
com.io7m.coffeepick.runtime.format.xml.FormatXMLAbstractContentHandler<ParserResultType,​ParserResultType>
com.io7m.coffeepick.runtime.format.xml.FormatXML1TopLevelHandler

All Implemented Interfaces:
  `FormatXMLContentHandlerType<ParserResultType>`

    public final class FormatXML1TopLevelHandler
    extends FormatXMLAbstractContentHandler<ParserResultType,​ParserResultType>

A content handler for parsing top-level values.

- ## Constructor Summary

  Constructors
  Constructor | Description
  --- | ---
  `FormatXML1TopLevelHandler​(org.xml.sax.ext.Locator2 in_locator)` | Construct a handler.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `protected void` | `onChildResultReceived​(ParserResultType value)` | A value was received from a child handler.
  `protected java.util.Optional<ParserResultType>` | `onElementFinishDirectly​(java.lang.String namespace, java.lang.String name, java.lang.String qname)` |
  `protected void` | `onElementStartDirectly​(java.lang.String namespace, java.lang.String name, java.lang.String qname, org.xml.sax.Attributes attributes)` |
  `protected java.util.Map<java.lang.String,​java.util.function.Supplier<FormatXMLContentHandlerType<ParserResultType>>>` | `onWantChildHandlers()` |
  `protected java.lang.String` | `onWantHandlerName()` |

  ### Methods inherited from class com.io7m.coffeepick.runtime.format.xml.FormatXMLAbstractContentHandler

  `finish, get, locator, map, onCharacters, onElementFinished, onElementStarted, toString`

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

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

- ## Constructor Details

  - ### FormatXML1TopLevelHandler

    public FormatXML1TopLevelHandler​(org.xml.sax.ext.Locator2 in_locator)
    Construct a handler.
    Parameters:
      `in_locator` - An XML locator

- ## Method Details

  - ### onWantChildHandlers

    protected java.util.Map<java.lang.String,​java.util.function.Supplier<FormatXMLContentHandlerType<ParserResultType>>> onWantChildHandlers()
    Specified by:
      `onWantChildHandlers` in class `FormatXMLAbstractContentHandler<ParserResultType,​ParserResultType>`

  - ### onWantHandlerName

    protected java.lang.String onWantHandlerName()
    Specified by:
      `onWantHandlerName` in class `FormatXMLAbstractContentHandler<ParserResultType,​ParserResultType>`

  - ### onElementFinishDirectly

    protected java.util.Optional<ParserResultType> onElementFinishDirectly​(java.lang.String namespace, java.lang.String name, java.lang.String qname)
    Specified by:
      `onElementFinishDirectly` in class `FormatXMLAbstractContentHandler<ParserResultType,​ParserResultType>`

  - ### onElementStartDirectly

    protected void onElementStartDirectly​(java.lang.String namespace, java.lang.String name, java.lang.String qname, org.xml.sax.Attributes attributes)
    Specified by:
      `onElementStartDirectly` in class `FormatXMLAbstractContentHandler<ParserResultType,​ParserResultType>`

  - ### onChildResultReceived

    protected void onChildResultReceived​(ParserResultType value)
    Description copied from class: `FormatXMLAbstractContentHandler`
    A value was received from a child handler.
    Specified by:
      `onChildResultReceived` in class `FormatXMLAbstractContentHandler<ParserResultType,​ParserResultType>`
    Parameters:
      `value` - The result value