Package gnu.lists

Interface Consumer

All Superinterfaces:
Appendable, Consumer<Object>, DoubleConsumer, IntConsumer, LongConsumer
All Known Subinterfaces:
XConsumer
All Known Implementing Classes:
ContentConsumer, FilterConsumer, HttpPrinter, KawaXMLReader, NamedChildrenFilter, Nodes, NodeTree, OrderedTuples, PrintConsumer, RelativeStepFilter, ServletPrinter, SortedNodes, TreeList, Values.FromTreeList, VoidConsumer, XMLFilter, XMLPrinter, XslTranslator

public interface Consumer extends Appendable, Consumer<Object>, IntConsumer, LongConsumer, DoubleConsumer
A Consumer is something that will accept data (output), and do something with it. A consumer is like a SAX DocumentHandler or a PrintWriter, but more abstract. If a Sequence class impleemnts Consumer, then data "written" to the sequence will be inserted in the sequence.

Note: This interface is not quite final. For example it is probable we will add methods for comments, processing instructions, etc.

  • Method Details

    • writeBoolean

      void writeBoolean(boolean v)
    • writeFloat

      void writeFloat(float v)
    • writeDouble

      void writeDouble(double v)
    • writeInt

      void writeInt(int v)
    • writeLong

      void writeLong(long v)
    • startDocument

      void startDocument()
    • endDocument

      void endDocument()
    • startElement

      void startElement(Object type)
    • endElement

      void endElement()
    • startAttribute

      void startAttribute(Object attrType)
      Write a attribute for the current element. This is only allowed immediately after a startElement.
    • endAttribute

      void endAttribute()
      End of an attribute or end of an actual parameter. The former use matches a startAttribute; the latter may not, and can be used to separate parameters in a parameter list. This double duty suggsts the method should at least be re-named.
    • writeObject

      void writeObject(Object v)
    • ignoring

      boolean ignoring()
      True if consumer is ignoring rest of element. The producer can use this information to skip ahead.
    • write

      void write(int ch)
    • write

      void write(String string)
    • write

      void write(CharSequence string, int start, int length)
    • write

      void write(char[] buf, int start, int length)
    • append

      Consumer append(char c)
      Specified by:
      append in interface Appendable
    • append

      Consumer append(CharSequence csq)
      Specified by:
      append in interface Appendable
    • append

      Consumer append(CharSequence csq, int start, int end)
      Specified by:
      append in interface Appendable
    • accept

      default void accept(Object t)
      Specified by:
      accept in interface Consumer<Object>
    • accept

      default void accept(int t)
      Specified by:
      accept in interface IntConsumer
    • accept

      default void accept(long t)
      Specified by:
      accept in interface LongConsumer
    • accept

      default void accept(double t)
      Specified by:
      accept in interface DoubleConsumer