Package org.oddjob.arooa

Interface ArooaConfiguration

All Known Subinterfaces:
ConfigurationNode<P>, DragPoint
All Known Implementing Classes:
AbstractConfigurationNode, DesignConfiguration, DragConfiguration, DragContext, ElementConfiguration, JsonConfiguration, QTagConfiguration, SimpleParseContext.SimpleConfigNode, XMLConfiguration, XMLConfigurationNode
public interface ArooaConfiguration
An ArooaConfiguration is something that accepts a ParseContext and uses that context to provide a ConfigurationHandle.

The result is typically generated by iterating over or parsing whatever the configuration encapsulates using as its starting point the ElementHandler provided by the parent context.

An ArooaConfiguration is intended to be used in conjunction with an ArooaParser which provides the context.

Author:
rob

  • Method Summary

    Modifier and Type
    Method
    Description
    <P extends ParseContext<P>>
    ConfigurationHandle<P>
    parse(P parseParentContext)
    Parse the encapsulated configuration.

  • Method Details

    • parse

      <P extends ParseContext<P>> ConfigurationHandle<P> parse(P parseParentContext) throws ArooaParseException
      Parse the encapsulated configuration.
      Type Parameters:
      P - The type of the context in which parsing occurs.
      Parameters:
      parseParentContext - The context in which this configuration will be parsed. This context will provide the ArooaHandler, and therefore subsequent child contexts.
      Returns:
      A ConfigurationHandle. The handle provides access to the context created as the result of the parse and a way of saving this context back into the configuration.
      Throws:
      ArooaParseException - If parsing fails.