gnu.lists
Interface Consumer

All Superinterfaces:

java.lang.Appendable

All Known Subinterfaces:

XConsumer

All Known Implementing Classes:

CharArrayOutPort, ContentConsumer, FilterConsumer, HttpPrinter, KawaXMLReader, NamedChildrenFilter, Nodes, NodeTree, OrderedTuples, OutPort, PrintConsumer, RelativeStepFilter, ReplPaneOutPort, ServletPrinter, SortedNodes, TreeList, Values, ValueStack, VoidConsumer, XMLFilter, XMLPrinter, XslTranslator

public interface Consumer
extends java.lang.Appendable

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 Summary

Consumer	append(char c)
Consumer	append(java.lang.CharSequence csq)
Consumer	append(java.lang.CharSequence csq, int start, int end)
void	endAttribute() End of an attribute or end of an actual parameter.
void	endDocument()
void	endElement()
boolean	ignoring() True if consumer is ignoring rest of element.
void	startAttribute(java.lang.Object attrType) Write a attribute for the current element.
void	startDocument()
void	startElement(java.lang.Object type)
void	write(char[] buf, int start, int length)
void	write(java.lang.CharSequence string, int start, int length)
void	write(int ch)
void	write(java.lang.String string)
void	writeBoolean(boolean v)
void	writeDouble(double v)
void	writeFloat(float v)
void	writeInt(int v)
void	writeLong(long v)
void	writeObject(java.lang.Object v)

Method Detail

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(java.lang.Object type)

endElement

void endElement()

startAttribute

void startAttribute(java.lang.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(java.lang.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(java.lang.String string)

write

void write(java.lang.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 java.lang.Appendable

append

Consumer append(java.lang.CharSequence csq)

Specified by:

append in interface java.lang.Appendable

append

Consumer append(java.lang.CharSequence csq,
                int start,
                int end)

Specified by:

append in interface java.lang.Appendable