com.mulesoft.connectors.rosettanet.extension.internal.xml

Class WrappedReader

java.lang.Object

com.mulesoft.connectors.rosettanet.extension.internal.xml.WrappedReader

public class WrappedReader
extends Object

Reader for RosettaNet XML document component, which may be a header or the service content (for generated actions). TODO: rework this to use Stax2 validation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WrappedReader.ErrorInfo

Constructor Summary

Constructors

Constructor and Description
WrappedReader(InputStream is)

Method Summary

Modifier and Type	Method and Description
boolean	checkElement(String name) Check for an optional element present in the input.
void	closeElement() Read required element end tag.
void	closeNested(int count) Read nested element end tags.
List<WrappedReader.ErrorInfo>	getErrorList() Get list of verification errors.
void	init(String type) Initialize reader state.
void	openElement(String name) Read required element start tag.
void	openNested(String... names) Read nested element start tags.
String	readElement(String name) Read trimmed text content of required next element.
String	readNested(String... names) Read trimmed text content of nested element.
void	skipElement(String name) Skip element including all nested content.
void	skipOptionalElement(String name) Skip optional element including all nested content.
void	validate() Validate document, discarding all data.
void	verifyElement(String value, String name) Verify trimmed text content of element matches expected value.
void	verifyNested(String value, String... names) Verify trimmed text content of element matches expected value.

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappedReader

public WrappedReader(InputStream is)
              throws XMLStreamException

Throws:

XMLStreamException

Method Detail

init

public void init(String type)
          throws XMLStreamException

Initialize reader state. This verifies and skips the XML declaration and document type definition, verifying the XML version, character encoding, and document name.

Parameters:

type -

Throws:

XMLStreamException

validate

public void validate()
              throws XMLStreamException

Validate document, discarding all data.

Throws:

XMLStreamException

getErrorList

public List<WrappedReader.ErrorInfo> getErrorList()

Get list of verification errors.

Returns:

errors

checkElement

public boolean checkElement(String name)
                     throws XMLStreamException

Check for an optional element present in the input. If the element is found, it should be processed by reading normally.

Parameters:

name -

Returns:

true if present, false if not

Throws:

XMLStreamException

openElement

public void openElement(String name)
                 throws XMLStreamException

Read required element start tag.

Parameters:

name - element local name

Throws:

XMLStreamException

openNested

public void openNested(String... names)
                throws XMLStreamException

Read nested element start tags.

Parameters:

names -

Throws:

XMLStreamException

closeElement

public void closeElement()
                  throws XMLStreamException

Read required element end tag. If any element content is present before the end tag the content is recorded as an error and skipped.

Throws:

XMLStreamException

closeNested

public void closeNested(int count)
                 throws XMLStreamException

Read nested element end tags. If any element content is present before the end tag the content is recorded as an error and skipped.

Parameters:

count -

Throws:

XMLStreamException

skipElement

public void skipElement(String name)
                 throws XMLStreamException

Skip element including all nested content. The parser must be positioned at the element start tag when this is called. It returns with the parser positioned past the corresponding element end tag.

Parameters:

name -

Throws:

XMLStreamException

skipOptionalElement

public void skipOptionalElement(String name)
                         throws XMLStreamException

Skip optional element including all nested content. If the parser is positioned at the element start tag when this is called the element is skipped and the parser is positioned past the corresponding element end tag on return.

Parameters:

name -

Throws:

XMLStreamException

readElement

public String readElement(String name)
                   throws XMLStreamException

Read trimmed text content of required next element. Note that this advances the parser to the element end tag.

Parameters:

name -

Returns:

text

Throws:

XMLStreamException

readNested

public String readNested(String... names)
                  throws XMLStreamException

Read trimmed text content of nested element. Note that this advances the parser to the element end tag.

Parameters:

names -

Returns:

text content, null if empty

Throws:

XMLStreamException

verifyElement

public void verifyElement(String value,
                          String name)
                   throws XMLStreamException

Verify trimmed text content of element matches expected value. Note that this advances the parser to the element end tag.

Parameters:

value -

name -

Throws:

XMLStreamException

verifyNested

public void verifyNested(String value,
                         String... names)
                  throws XMLStreamException

Verify trimmed text content of element matches expected value. Note that this advances the parser to the element end tag.

Parameters:

value -

names -

Throws:

XMLStreamException