Package org.codehaus.mojo.versions.rewriting

Class MutableXMLStreamReader

java.lang.Object

javax.xml.stream.util.StreamReaderDelegate

org.codehaus.stax2.util.StreamReader2Delegate

org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader

All Implemented Interfaces:

AutoCloseable, XMLStreamConstants, XMLStreamReader, org.codehaus.stax2.typed.TypedXMLStreamReader, org.codehaus.stax2.validation.Validatable, org.codehaus.stax2.XMLStreamReader2

public class MutableXMLStreamReader
extends org.codehaus.stax2.util.StreamReader2Delegate
implements AutoCloseable

A mutable XMLStreamReader2, allowing simple string manipulation (replacement) of the underlying document

Field Summary

Fields inherited from class org.codehaus.stax2.util.StreamReader2Delegate

_delegate2

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Fields inherited from interface org.codehaus.stax2.XMLStreamReader2

FEATURE_DTD_OVERRIDE

Constructor Summary

Constructors

Constructor	Description
MutableXMLStreamReader(InputStream inputStream, Path fileName)	Constructs a new object using the contents of the given input stream as the initial contents of the document.
MutableXMLStreamReader(Path path)	Constructs a new object using the contents of the given file as the initial contents of the document.

Method Summary

Modifier and Type	Method	Description
void	clearMark(Object markNr)	Removes the mark under the given markNr
String	getBetween(Object mark1, Object mark2)	Returns the substring of the document between the end of the first mark and the start of the second marked element
int	getCurrentEndingCharOffset()	Returns current (adjusted by delta ending char offset
int	getCurrentStartingCharOffset()	Returns current (adjusted by delta starting char offset
Path	getFileName()	Returns the name of the file associated with the document
String	getSource()	Returns the current state of the document, in string format
boolean	hasMark(Object markNr)	If the mark with the given markNr has been recorded
boolean	isModified()	Whether the document has been modified
void	mark(Object markNr)	Records the current LocationInfo and delta under the given markNr
int	next()
void	replace(String replacement)	Replaces the current element with the replacement text
void	replaceBetween(Object mark1, Object mark2, String replacement)	Replaces the document between two marks with the given replacement.
void	replaceMark(Object mark, String replacement)	Replaces the document between the starting and ending character offset of the given mark
void	rewind()	Recreates the underlying delegate XMLStreamReader2 based on the current state of the document

Methods inherited from class org.codehaus.stax2.util.StreamReader2Delegate

closeCompletely, getAttributeAs, getAttributeAsArray, getAttributeAsBinary, getAttributeAsBinary, getAttributeAsBoolean, getAttributeAsDecimal, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsInteger, getAttributeAsLong, getAttributeAsLongArray, getAttributeAsQName, getAttributeIndex, getAttributeInfo, getDepth, getDTDInfo, getElementAs, getElementAsBinary, getElementAsBinary, getElementAsBoolean, getElementAsDecimal, getElementAsDouble, getElementAsFloat, getElementAsInt, getElementAsInteger, getElementAsLong, getElementAsQName, getFeature, getLocationInfo, getNonTransientNamespaceContext, getPrefixedName, getText, isEmptyElement, isPropertySupported, readElementAsArray, readElementAsBinary, readElementAsBinary, readElementAsDoubleArray, readElementAsFloatArray, readElementAsIntArray, readElementAsLongArray, setFeature, setParent, setProperty, setValidationProblemHandler, skipElement, stopValidatingAgainst, stopValidatingAgainst, validateAgainst

Methods inherited from class javax.xml.stream.util.StreamReaderDelegate

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getElementText, getEncoding, getEventType, getLocalName, getLocation, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getParent, getPIData, getPITarget, getPrefix, getProperty, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEndElement, isStandalone, isStartElement, isWhiteSpace, nextTag, require, standaloneSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface javax.xml.stream.XMLStreamReader

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getElementText, getEncoding, getEventType, getLocalName, getLocation, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getPIData, getPITarget, getPrefix, getProperty, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEndElement, isStandalone, isStartElement, isWhiteSpace, nextTag, require, standaloneSet

Constructor Details

MutableXMLStreamReader

public MutableXMLStreamReader(Path path)
                       throws IOException,
XMLStreamException,
TransformerException

Constructs a new object using the contents of the given file as the initial contents of the document.

Parameters:

path - file containing the initial document contents

Throws:

IOException - thrown in case of an I/O problems

XMLStreamException - thrown if the file cannot be parsed

TransformerException

MutableXMLStreamReader

public MutableXMLStreamReader(InputStream inputStream,
 Path fileName)
                       throws IOException,
XMLStreamException,
TransformerException

Constructs a new object using the contents of the given input stream as the initial contents of the document.

Parameters:

inputStream - stream containing the initial document contents

fileName - name of the file

Throws:

IOException - thrown in case of an I/O problems

XMLStreamException - thrown if the file cannot be parsed

TransformerException

Method Details

getFileName

public Path getFileName()

Returns the name of the file associated with the document

Returns:

name of the file associated with the document

getSource

public String getSource()

Returns the current state of the document, in string format

Returns:

current state of the document, in string format

isModified

public boolean isModified()

Whether the document has been modified

Returns:

true if the document has been modified

getCurrentStartingCharOffset

public int getCurrentStartingCharOffset()

Returns current (adjusted by delta starting char offset

Returns:

current (adjusted by delta starting char offset

getCurrentEndingCharOffset

public int getCurrentEndingCharOffset()

Returns current (adjusted by delta ending char offset

Returns:

current (adjusted by delta ending char offset

replace

public void replace(String replacement)

Replaces the current element with the replacement text

Parameters:

replacement - string replacing the current element

getBetween

public String getBetween(Object mark1,
 Object mark2)

Returns the substring of the document between the end of the first mark and the start of the second marked element

Parameters:

mark1 - starting mark of the substring

mark2 - ending mark of the substring

Returns:

substring of the document between two marks

replaceBetween

public void replaceBetween(Object mark1,
 Object mark2,
 String replacement)

Replaces the document between two marks with the given replacement.

Parameters:

mark1 - starting mark of the string to be replaced

mark2 - ending mark of the string to be replaced

replacement - replacement string

replaceMark

public void replaceMark(Object mark,
 String replacement)

Replaces the document between the starting and ending character offset of the given mark

Parameters:

mark - mark to be replaced between its starting and ending character offset

replacement - replacement string

rewind

public void rewind()
            throws XMLStreamException

Recreates the underlying delegate XMLStreamReader2 based on the current state of the document

Throws:

XMLStreamException - thrown if the document cannot be parsed

next

public int next()
         throws XMLStreamException

Specified by:

next in interface XMLStreamReader

Overrides:

next in class StreamReaderDelegate

Throws:

XMLStreamException

hasMark

public boolean hasMark(Object markNr)

If the mark with the given markNr has been recorded

Parameters:

markNr - number of the mark to check

Returns:

true if the given mark exists

mark

public void mark(Object markNr)

Records the current LocationInfo and delta under the given markNr

Parameters:

markNr - number of the mark to record to

clearMark

public void clearMark(Object markNr)

Removes the mark under the given markNr

Parameters:

markNr - number of the mark to remove