org.shared.net.handler

Class XmlHandler<H extends XmlHandler<H,C,T,S>,C extends Connection,T extends XmlEvent<T,?,S>,S extends Enum<S>>

java.lang.Object

org.shared.net.handler.AbstractFilteredHandler<H,C,T>

org.shared.net.handler.XmlHandler<H,C,T,S>

Type Parameters:

H - the parameterization lower bounded by XmlHandler itself.

C - the Connection type.

T - the XmlEvent type.

S - the Source enumeration type.

All Implemented Interfaces:

Closeable, AutoCloseable, EnumType<S>, Source<T,S>, SourceLocal<T>, SourceRemote<T>, ConnectionHandler<C>, FilterFactory<Filter<T,Element>,T,Element,H>, FilteredHandler<H,C,T>, OobHandler<C>

Direct Known Subclasses:

TestXmlHandler

public abstract class XmlHandler<H extends XmlHandler<H,C,T,S>,C extends Connection,T extends XmlEvent<T,?,S>,S extends Enum<S>>
extends AbstractFilteredHandler<H,C,T>
implements Source<T,S>, FilterFactory<Filter<T,Element>,T,Element,H>

A null-terminated packet protocol for reading and writing XmlEvents. Programmers will have to implement parse(Element) for system-specific behavior.

Nested Class Summary

Nested classes/interfaces inherited from interface org.shared.net.ConnectionHandler

ConnectionHandler.ClosingType

Field Summary

Fields inherited from class org.shared.net.handler.AbstractFilteredHandler

dummyFuture

Constructor Summary

Constructors

Constructor and Description
XmlHandler(String name, S type, int maximumSize) Alternate constructor.
XmlHandler(String name, S type, int minimumSize, int maximumSize) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract T	createEos() Creates an end-of-stream XmlEvent.
protected abstract T	createError() Creates an error XmlEvent.
Handler<T>	getHandler() Gets the Handler that will process incoming Events.
S	getType() Gets the type.
Filter<T,Element>	newFilter(H handler) Creates a new Filter.
void	onBind(Queue<T> inputs) On binding.
void	onClose() On completion of closure.
void	onClosing(ConnectionHandler.ClosingType type, Queue<T> inputs) On closure.
void	onReceive(Queue<T> inputs) On receipt of data.
void	onRemote(T evt) Delivers an Event to the remote manifestation.
protected abstract T	parse(Element rootElement) Parses an XmlEvent from the given root DOM Element.
void	setHandler(Handler<T> handler) Sets the Handler that will process incoming Events.

Methods inherited from class org.shared.net.handler.AbstractFilteredHandler

close, getConnection, onBind, onClosing, onOob, onOob, onReceive, send, setConnection, setFilterFactory, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.shared.event.Source

close

Methods inherited from interface org.shared.event.SourceLocal

onLocal

Constructor Detail

XmlHandler

public XmlHandler(String name,
          S type,
          int minimumSize,
          int maximumSize)

Default constructor.

Parameters:

name - the name of this connection.

type - the SourceType.

minimumSize - the minimum message buffer size.

maximumSize - the maximum message buffer size.

XmlHandler

public XmlHandler(String name,
          S type,
          int maximumSize)

Alternate constructor.

Method Detail

parse

protected abstract T parse(Element rootElement)

Parses an XmlEvent from the given root DOM Element.

Parameters:

rootElement - the root DOM Element.

Returns:

the XmlEvent.

createEos

protected abstract T createEos()

Creates an end-of-stream XmlEvent.

Returns:

the XmlEvent.

createError

protected abstract T createError()

Creates an error XmlEvent.

Returns:

the XmlEvent.

getType

public S getType()

Description copied from interface: EnumType

Gets the type.

Specified by:

getType in interface EnumType<S extends Enum<S>>

getHandler

public Handler<T> getHandler()

Description copied from interface: Source

Gets the Handler that will process incoming Events.

Specified by:

getHandler in interface Source<T extends XmlEvent<T,?,S>,S extends Enum<S>>

setHandler

public void setHandler(Handler<T> handler)

Description copied from interface: Source

Sets the Handler that will process incoming Events.

Specified by:

setHandler in interface Source<T extends XmlEvent<T,?,S>,S extends Enum<S>>

onRemote

public void onRemote(T evt)

Description copied from interface: SourceRemote

Delivers an Event to the remote manifestation.

Specified by:

onRemote in interface SourceRemote<T extends XmlEvent<T,?,S>>

onReceive

public void onReceive(Queue<T> inputs)

Description copied from interface: FilteredHandler

On receipt of data.

Specified by:

onReceive in interface FilteredHandler<H extends XmlHandler<H,C,T,S>,C extends Connection,T extends XmlEvent<T,?,S>>

Parameters:

inputs - the input Queue.

onClosing

public void onClosing(ConnectionHandler.ClosingType type,
             Queue<T> inputs)

Description copied from interface: FilteredHandler

On closure.

Specified by:

onClosing in interface FilteredHandler<H extends XmlHandler<H,C,T,S>,C extends Connection,T extends XmlEvent<T,?,S>>

Parameters:

type - the ConnectionHandler.ClosingType.

inputs - the input Queue.

See Also:

ConnectionHandler.ClosingType

newFilter

public Filter<T,Element> newFilter(H handler)

Description copied from interface: FilterFactory

Creates a new Filter.

Specified by:

newFilter in interface FilterFactory<Filter<T extends XmlEvent<T,?,S>,Element>,T extends XmlEvent<T,?,S>,Element,H extends XmlHandler<H,C,T,S>>

onBind

public void onBind(Queue<T> inputs)

Description copied from interface: FilteredHandler

On binding.

Specified by:

onBind in interface FilteredHandler<H extends XmlHandler<H,C,T,S>,C extends Connection,T extends XmlEvent<T,?,S>>

Parameters:

inputs - the input Queue.

onClose

public void onClose()

Description copied from interface: ConnectionHandler

On completion of closure.

Specified by:

onClose in interface ConnectionHandler<C extends Connection>