de.hybris.bootstrap.xml

Class UndoableXMLOutputter

java.lang.Object

XMLOutputter

de.hybris.bootstrap.xml.UndoableXMLOutputter

public class UndoableXMLOutputter
extends XMLOutputter

XML outputter wrapper implementation which allows to write a certain amount of data and removing it afterwards from the output. This class uses a UndoableWriterWrapper instance.

 UndoableXMLOutputter xout = new UndoableXMLOutputter(actualWriter);
 
 // start undoable writing
 xout.markSavePoint();
 try
 {
        // ... write xml ...
 
        // finally store changes
        xout.commitSavePoint();
 }
 catch (Exception e)
 {
        // discard any changes and restore outputter state
        xout.restoreSavePoint();
 }
 

Method Summary

Modifier and Type	Method and Description
void	commitSavePoint() Stores all xml data which has been written since markSavePoint() has been called to the underlying writer.
boolean	hasSavePoint() Tells whether or not undoable writing has been started or not.
void	markSavePoint() Starts undoable xml writing.
void	restoreSavePoint() Discards all xml data which has been written since markSavePoint() has been called.

Methods inherited from class java.lang.Object

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

Method Detail

markSavePoint

public void markSavePoint()

Starts undoable xml writing. Be sure to call either commitSavePoint() or restoreSavePoint() at the end of undoable writing period.

Throws:

java.lang.IllegalStateException - if called twice before either commitSavePoint() or restoreSavePoint() have been called

hasSavePoint

public boolean hasSavePoint()

Tells whether or not undoable writing has been started or not.

restoreSavePoint

public void restoreSavePoint()

Discards all xml data which has been written since markSavePoint() has been called. The prevous outputter state is restored (opened tag, indentation level, ... ).

From now on undoable writing is disabled until markSavePoint() is called again.

commitSavePoint

public void commitSavePoint()

Stores all xml data which has been written since markSavePoint() has been called to the underlying writer.

From now on undoable writing is disabled until markSavePoint() is called again.