org.codehaus.staxmate.out
Interface SMBufferable

All Known Implementing Classes:

SMBufferedElement, SMBufferedFragment

public interface SMBufferable

Interface that denotes output objects (fragments, elements) that explicitly start their life-cycle as buffered (other objects can be implicitly buffered due to explict ones as parents or previous siblings).

Method Summary

boolean	isBuffered()
void	linkParent(SMOutputContainer parent, boolean blocked) Method called by a container when bufferable item is linked as its child.
void	release() Method called to signal that the node need not be buffered any more (if not required to do so by parent/children restrictions)

Method Detail

release

void release()
             throws javax.xml.stream.XMLStreamException

Method called to signal that the node need not be buffered any more (if not required to do so by parent/children restrictions)

Throws:

javax.xml.stream.XMLStreamException

isBuffered

boolean isBuffered()

Returns:

True if this object is still buffered; false if not

linkParent

void linkParent(SMOutputContainer parent,
                boolean blocked)
                throws javax.xml.stream.XMLStreamException

Method called by a container when bufferable item is linked as its child. It should not only add parent linkage, but also do any output necessary, if this item is not buffered or blocked.

Parameters:

parent - Container to attach bufferable instance under

blocked - If true, parent output is blocked (and as the result so is bufferable's); if false, parent is (and will remain) unblocked.

Throws:

javax.xml.stream.XMLStreamException