Class OutputStack

java.lang.Object
java.util.AbstractCollection<OutputNode>
java.util.AbstractList<OutputNode>
java.util.ArrayList<OutputNode>
org.simpleframework.xml.stream.OutputStack
All Implemented Interfaces:
Serializable, Cloneable, Iterable<OutputNode>, Collection<OutputNode>, List<OutputNode>, RandomAccess, SequencedCollection<OutputNode>
class OutputStack extends ArrayList<OutputNode>
The OutputStack is used to keep track of the nodes that have been written to the document. This ensures that when nodes are written to the XML document that the writer can tell whether a child node for a given OutputNode can be created. Each created node is pushed, and popped when ended.
See Also:

  • Field Details

    • active

      private final Set active
      Represents the set of nodes that have not been committed.

  • Constructor Details

    • OutputStack

      public OutputStack(Set active)
      Constructor for the OutputStack object. This is used to create a stack that can be used to keep track of the elements that have been written to the XML document.

  • Method Details

    • pop

      public OutputNode pop()
      This is used to remove the OutputNode from the top of the output stack. This is used when an element has been ended and the output writer wants to block child creation.
      Returns:
      this returns the node from the top of the stack

    • top

      public OutputNode top()
      This is used to acquire the OutputNode from the top of the output stack. This is used when the writer wants to determine the current element written to the XML document.
      Returns:
      this returns the node from the top of the stack

    • bottom

      public OutputNode bottom()
      This is used to acquire the OutputNode from the bottom of the output stack. This is used when the writer wants to determine the root element for the written XML document.
      Returns:
      this returns the node from the bottom of the stack

    • push

      public OutputNode push(OutputNode value)
      This method is used to add an OutputNode to the top of the stack. This is used when an element is written to the XML document, and allows the writer to determine if a child node can be created from a given output node.
      Parameters:
      value - this is the output node to add to the stack

    • purge

      public OutputNode purge(int index)
      The purge method is used to purge a match from the provided position. This also ensures that the active set has the node removed so that it is no longer relevant.
      Parameters:
      index - the index of the node that is to be removed
      Returns:
      returns the node removed from the specified index

    • iterator

      public Iterator<OutputNode> iterator()
      This is returns an Iterator that is used to loop through the ouptut nodes from the top down. This allows the node writer to determine what Mode should be used by an output node. This reverses the iteration of the list.
      Specified by:
      iterator in interface Collection<OutputNode>
      Specified by:
      iterator in interface Iterable<OutputNode>
      Specified by:
      iterator in interface List<OutputNode>
      Overrides:
      iterator in class ArrayList<OutputNode>
      Returns:
      returns an iterator to iterate from the top down