Module org.tquadrat.foundation.xml

Package org.tquadrat.foundation.xml.parse.spi

Interface HandlerProvider

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@ClassVersion(sourceVersion="$Id: HandlerProvider.java 820 2020-12-29 20:34:22Z tquadrat $")
@API(status=EXPERIMENTAL,
     since="0.0.5")
@FunctionalInterface
public interface HandlerProvider

The interface for a function that returns an instance of XMLParseEventHandler for an XML element.

This is a functional interface whose functional method is retrieveHandler(String).

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: HandlerProvider.java 820 2020-12-29 20:34:22Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.xml.parse.spi.HandlerProvider"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final HandlerProvider[]	EMPTY_HandlerProvider_ARRAY	An empty array of HandlerProvider objects.

Method Summary

Modifier and Type	Method	Description
XMLParseEventHandler<?>	retrieveHandler(String elementName)	Retrieves the XML parse event handler for the given element name.

Field Details

EMPTY_HandlerProvider_ARRAY

static final HandlerProvider[] EMPTY_HandlerProvider_ARRAY

An empty array of HandlerProvider objects.

Method Details

retrieveHandler

XMLParseEventHandler<?> retrieveHandler(String elementName)
                                 throws XMLStreamException

Retrieves the XML parse event handler for the given element name.

Parameters:

elementName - The name of the element to handle.

Returns:

The requested instance of XMLParseEventHandler.

Throws:

XMLStreamException - There is no registered handler for the given element name.