org.expasy.mzjava.core.io.ms.spectrum

Class MzxmlReader.XMLEventUtils

java.lang.Object

org.expasy.mzjava.core.io.ms.spectrum.MzxmlReader.XMLEventUtils

Enclosing class:

MzxmlReader

public static class MzxmlReader.XMLEventUtils
extends Object

Author:

fnikitin Date: 6/27/13

Constructor Summary

Constructors

Constructor and Description
MzxmlReader.XMLEventUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getMandatoryAttribute(StartElement startElement, String attributeName, String... alternateNames)
static <E extends XMLEvent> E	getMandatoryXMLEvent(com.google.common.base.Optional<E> mandatoryEvent, String message)
static com.google.common.base.Optional<String>	getOptionalAttribute(StartElement startElement, String attributeName)
static com.google.common.base.Optional<Characters>	nextCharacters(XMLEventReader reader)
static com.google.common.base.Optional<StartElement>	nextStartElementIf(XMLEventReader reader, String tagName) Return the next start element only if match tagName.
static com.google.common.base.Optional<Characters>	seekNextCharacters(XMLEventReader reader)
static com.google.common.base.Optional<StartElement>	seekStartElement(XMLEventReader reader, String tagName) Seek to the next start tag
static void	writeAllEventsUntilStartElement(XMLEventReader reader, String tagName, Writer writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

MzxmlReader.XMLEventUtils

public MzxmlReader.XMLEventUtils()

Method Detail

seekStartElement

public static com.google.common.base.Optional<StartElement> seekStartElement(XMLEventReader reader,
                                                             String tagName)
                                                                      throws XMLStreamException

Seek to the next start tag

Parameters:

reader - the xml reader

tagName - the start element name to return

Returns:

optional scan start element

Throws:

XMLStreamException

nextStartElementIf

public static com.google.common.base.Optional<StartElement> nextStartElementIf(XMLEventReader reader,
                                                               String tagName)
                                                                        throws XMLStreamException

Return the next start element only if match tagName.

Parameters:

reader - the xml reader

tagName - the start element name to return

Returns:

optional StartElement

Throws:

XMLStreamException

seekNextCharacters

public static com.google.common.base.Optional<Characters> seekNextCharacters(XMLEventReader reader)
                                                                      throws XMLStreamException

Throws:

XMLStreamException

nextCharacters

public static com.google.common.base.Optional<Characters> nextCharacters(XMLEventReader reader)
                                                                  throws XMLStreamException

Throws:

XMLStreamException

getOptionalAttribute

public static com.google.common.base.Optional<String> getOptionalAttribute(StartElement startElement,
                                                           String attributeName)

getMandatoryAttribute

public static String getMandatoryAttribute(StartElement startElement,
                           String attributeName,
                           String... alternateNames)
                                    throws XMLStreamException

Throws:

XMLStreamException

getMandatoryXMLEvent

public static <E extends XMLEvent> E getMandatoryXMLEvent(com.google.common.base.Optional<E> mandatoryEvent,
                                          String message)
                                               throws XMLStreamException

Throws:

XMLStreamException

writeAllEventsUntilStartElement

public static void writeAllEventsUntilStartElement(XMLEventReader reader,
                                   String tagName,
                                   Writer writer)
                                            throws XMLStreamException

Throws:

XMLStreamException