Package org.codehaus.staxmate.out

Class SMBufferedFragment

  • All Implemented Interfaces:
    SMBufferable
    public final class SMBufferedFragment
extends SMOutputContainer
implements SMBufferable
    Buffered fragment; starts its life buffered, so that its content are not automatically written to the underlying stream, but only when buffered instance is released. Once released, can not be buffered again.

    • Field Detail

      • STATE_BUFFERED_AND_BLOCKED

        protected static final int STATE_BUFFERED_AND_BLOCKED
        See Also:
        Constant Field Values

      • _state

        protected int _state
        All instances are initially buffered; state will be changed when instance is released (and further on with other changes)

    • Constructor Detail

      • SMBufferedFragment

        protected SMBufferedFragment​(SMOutputContext ctxt)

    • Method Detail

      • isBuffered

        public boolean isBuffered()
        Specified by:
        isBuffered in interface SMBufferable
        Returns:
        True if this object is still buffered; false if not

      • linkParent

        public void linkParent​(SMOutputContainer parent,
                       boolean blocked)
                throws javax.xml.stream.XMLStreamException
        Description copied from interface: SMBufferable
        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.
        Specified by:
        linkParent in interface SMBufferable
        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

      • release

        public void release()
             throws javax.xml.stream.XMLStreamException
        Description copied from interface: SMBufferable
        Method called to signal that the node need not be buffered any more (if not required to do so by parent/children restrictions)
        Specified by:
        release in interface SMBufferable
        Throws:
        javax.xml.stream.XMLStreamException

      • _childReleased

        protected void _childReleased​(SMOutputtable child)
                       throws javax.xml.stream.XMLStreamException
        Description copied from class: SMOutputContainer
        Method called by a child, when it is released and neither is or contains any buffered entities. This should indicate that it can be output unless one of its parents or preceding siblings is buffered. Container is expected to update its own state, and then inform its own parent (if necesary) about release; this may cascade output from parents up the container stack.
        Specified by:
        _childReleased in class SMOutputContainer
        Parameters:
        child - Child node that now neither is nor contains any buffered nodes.
        Throws:
        javax.xml.stream.XMLStreamException

      • _output

        protected boolean _output​(SMOutputContext ctxt,
                          boolean canClose)
                   throws javax.xml.stream.XMLStreamException
        Description copied from class: SMOutputtable
        Method called to request that the entity output itself; either as much as it can without closing, or as much as it can if it is to get closed. In both cases output can fail or be only a partial one: buffered nodes will not be output at all, and nodes with buffered children can only be partially output.
        Specified by:
        _output in class SMOutputContainer
        Parameters:
        ctxt - Output context to use for outputting this node (and its contents)
        canClose - If true, indicates that the node can (and should) be fully closed if possible. This (passing true) is usually done when a new sibling is added after a node (element/fragment); if so, current one should be recursively closed. If false, should only try to output as much as can be done without forcing closures.
        Returns:
        True if the whole node could be output, ie. neither it nor its children are buffered.
        Throws:
        javax.xml.stream.XMLStreamException

      • _canOutputNewChild

        public boolean _canOutputNewChild()
                           throws javax.xml.stream.XMLStreamException
        Description copied from class: SMOutputContainer
        Method called to figure out if we can just output a newly added child, without any buffering. It will request container to close and output all non-buffered children it has, if any; and indicate whether it was fully succesful or not.
        Specified by:
        _canOutputNewChild in class SMOutputContainer
        Returns:
        True if all children (if any) were completely output; false if there was at least one buffered child that couldn't be output.
        Throws:
        javax.xml.stream.XMLStreamException

      • getPath

        public void getPath​(java.lang.StringBuilder sb)
        Description copied from class: SMOutputContainer
        Method that can be called to get an XPath like description of the relative location of this output node, starting from root. Path will be appended to given StringBuilder.
        Specified by:
        getPath in class SMOutputContainer