org.kohsuke.maven.rewrite

Class Mark

java.lang.Object

org.kohsuke.maven.rewrite.Mark

public class Mark
extends Object

Points to a single event in XML, which is a region of characters.

Author:

Kohsuke Kawaguchi

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Releases this mark.
boolean	contains(Mark that) Does this mark contains the other mark?
boolean	equals(Object o) Check if two marks points to the same range.
int	hashCode()
boolean	isLeftOf(Mark that)
boolean	isRightOf(Mark that)
void	replace(String replacement) Replaces what this mark is pointing at by the specified text.
void	set() Update this mark to point to the current location.
void	set(Mark that)
Mark	to(Mark that) Creates a new mark that spans the range in between this and that mark.
Mark	toCurrent() Creates a new mark that spans the range in between this mark and the current position of XmlPatcher.
String	toString()
String	verbatim() Gets the XML text that this mark is pointing at.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

clear

public void clear()

Releases this mark. Until closed, a mark is tracked by XmlPatcher, so it'll leak memory unless it's cleared at the end. A mark can also get automatically closed if an update to another mark renders this mark obsolete.

verbatim

public String verbatim()

Gets the XML text that this mark is pointing at.

replace

public void replace(String replacement)

Replaces what this mark is pointing at by the specified text.

set

public void set()

Update this mark to point to the current location.

isLeftOf

public boolean isLeftOf(Mark that)

isRightOf

public boolean isRightOf(Mark that)

set

public void set(Mark that)

equals

public boolean equals(Object o)

Check if two marks points to the same range.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

contains

public boolean contains(Mark that)

Does this mark contains the other mark?

to

public Mark to(Mark that)

Creates a new mark that spans the range in between this and that mark.

toCurrent

public Mark toCurrent()

Creates a new mark that spans the range in between this mark and the current position of XmlPatcher.

toString

public String toString()

Overrides:

toString in class Object