org.jsefa.xml.lowlevel

Interface XmlLowLevelDeserializer

All Superinterfaces:

LowLevelDeserializer

All Known Implementing Classes:

StaxBasedXmlLowLevelDeserializer, XmlPullBasedXmlLowLevelDeserializer

public interface XmlLowLevelDeserializer
extends LowLevelDeserializer

Low level XML Deserializer.

Author:

Norman Lahme-Huetig

Method Summary

Methods

Modifier and Type	Method and Description
XmlItem	current() Returns the current xml item.
int	currentDepth() Returns the current element depth.
XmlItemType	currentType() Returns the type of the current xml item.
boolean	hasNext() Returns true if another xml item can be deserialized from the stream.
void	moveToNext() Moves to the next xml item which can be deserialized.
void	open(Reader reader, String systemId) Opens a new deserialization stream based on the given reader and system id.

Methods inherited from interface org.jsefa.common.lowlevel.LowLevelDeserializer

close, getInputPosition, open

Method Detail

open

void open(Reader reader,
        String systemId)

Opens a new deserialization stream based on the given reader and system id.

Parameters:

reader - the reader to base the stream on.

systemId - the system ID of the stream as an URI string. Will be used to resolve relative URIs.

Throws:

LowLevelDeserializationException

hasNext

boolean hasNext()

Returns true if another xml item can be deserialized from the stream.

Returns:

true, if another xml item can be deserialized from the stream, otherwise false.

Throws:

LowLevelDeserializationException

moveToNext

void moveToNext()

Moves to the next xml item which can be deserialized.

Throws:

LowLevelDeserializationException

currentType

XmlItemType currentType()

Returns the type of the current xml item. See XmlItemType for the different values allowed.

Returns:

the type of the current xml item.

current

XmlItem current()

Returns the current xml item.

Returns:

the current xml item.

Throws:

LowLevelDeserializationException

currentDepth

int currentDepth()

Returns the current element depth.

The depth of the root element is 0.

Returns:

the current depth.