Module org.panteleyev.commons

Package org.panteleyev.commons.xml

Class XMLEventReaderWrapper

java.lang.Object

org.panteleyev.commons.xml.XMLEventReaderWrapper

All Implemented Interfaces:

AutoCloseable

public class XMLEventReaderWrapper
extends Object
implements AutoCloseable

Implements convenience wrapper for XMLEventReader instances.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the wrapped reader.
Optional<String>	getElementText()	Reads the content of a text-only element.
boolean	getElementValue(boolean defaultValue)	Reads the content of a text-only element as boolean.
int	getElementValue(int defaultValue)	Reads the content of a text-only element as integer.
long	getElementValue(long defaultValue)	Reads the content of a text-only element as long.
<T> Optional<T>	getElementValue(Class<T> type)	Reads the content of a text-only element as typed value.
<T> T	getElementValue(T defaultValue)	Reads the content of a text-only element as typed value.
XMLEventReader	getReader()	Returns wrapped reader instance.
boolean	hasNext()	Checks if there is next event available.
static XMLEventReaderWrapper	newInstance(InputStream inputStream)	Creates new instance of XMLStreamWriterWrapper with default options.
static XMLEventReaderWrapper	newInstance(InputStream inputStream, Set<SerializationOption> options)	Creates new instance of XMLStreamWriterWrapper.
XMLEventWrapper	nextEvent()	Returns wrapped next event.
Optional<XMLEventWrapper>	peek()	Check the next XMLEvent without reading it from the stream.

Methods inherited from class java.lang.Object

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

Method Details

newInstance

public static XMLEventReaderWrapper newInstance(InputStream inputStream)

Creates new instance of XMLStreamWriterWrapper with default options.

Parameters:

inputStream - input stream

Returns:

wrapper instance

newInstance

public static XMLEventReaderWrapper newInstance(InputStream inputStream,
 Set<SerializationOption> options)

Creates new instance of XMLStreamWriterWrapper.

Parameters:

inputStream - input stream

Returns:

wrapper instance

getReader

public XMLEventReader getReader()

Returns wrapped reader instance.

Returns:

reader

close

public void close()

Closes the wrapped reader. See XMLEventReader.close().

Specified by:

close in interface AutoCloseable

hasNext

public boolean hasNext()

Checks if there is next event available. See XMLEventReader.hasNext().

Returns:

true if there is next event available

nextEvent

public XMLEventWrapper nextEvent()

Returns wrapped next event. See XMLEventReader.nextEvent().

Returns:

next event

peek

public Optional<XMLEventWrapper> peek()

Check the next XMLEvent without reading it from the stream. See XMLEventReader.peek().

Returns:

next event if available

getElementText

public Optional<String> getElementText()

Reads the content of a text-only element. See XMLEventReader.getElementText().

Returns:

element text

getElementValue

public boolean getElementValue(boolean defaultValue)

Reads the content of a text-only element as boolean.

Parameters:

defaultValue - default value

Returns:

boolean value

getElementValue

public int getElementValue(int defaultValue)

Reads the content of a text-only element as integer.

Parameters:

defaultValue - default value

Returns:

integer value

getElementValue

public long getElementValue(long defaultValue)

Reads the content of a text-only element as long.

Parameters:

defaultValue - default value

Returns:

long value

getElementValue

public <T> Optional<T> getElementValue(Class<T> type)

Reads the content of a text-only element as typed value.

Type Parameters:

T - expected value type

Parameters:

type - value type

Returns:

value

getElementValue

public <T> T getElementValue(T defaultValue)

Reads the content of a text-only element as typed value.

Type Parameters:

T - expected value type

Parameters:

defaultValue - default value

Returns:

value or default value if element text does not exist