gnu.lists

Class PrintConsumer

java.lang.Object

java.io.Writer

java.io.PrintWriter

gnu.lists.PrintConsumer

All Implemented Interfaces:

XConsumer, java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable, java.util.function.Consumer<java.lang.Object>, java.util.function.DoubleConsumer, java.util.function.IntConsumer, java.util.function.LongConsumer

Direct Known Subclasses:

HttpPrinter, gnu.kawa.io.OutPort, XMLPrinter

public class PrintConsumer
extends java.io.PrintWriter
implements java.lang.Appendable, XConsumer

A Consumer that extends a PrintWriter. Useful for formatting.

Field Summary

Fields

Modifier and Type	Field and Description
protected Consumer	base
protected boolean	skipping

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
PrintConsumer(Consumer out, boolean autoFlush)
PrintConsumer(java.io.OutputStream out, boolean autoFlush)
PrintConsumer(java.io.Writer out)
PrintConsumer(java.io.Writer out, boolean autoFlush)

Method Summary

Modifier and Type	Method and Description
PrintConsumer	append(char c)
PrintConsumer	append(java.lang.CharSequence csq)
PrintConsumer	append(java.lang.CharSequence csq, int start, int end)
protected void	beforeContent()
protected void	beforeNode()
void	beginEntity(java.lang.Object baseUri)
protected void	clearWordEnd()
void	endAttribute() End of an attribute or end of an actual parameter.
void	endDocument()
void	endElement()
void	endEntity()
void	endHiderSection() End section controled by a show/hide button
void	endLogicalBlock(java.lang.String suffix)
static void	endLogicalBlock(java.lang.String suffix, Consumer out)
protected void	endNumber()
void	freshLine()
gnu.kawa.io.PrettyWriter	getPrettyWriter()
boolean	ignoring() True if consumer is ignoring rest of element.
boolean	isDomTerm()
void	setIndentation(int amount, boolean current)
void	startAttribute(java.lang.Object attrType) Write a attribute for the current element.
void	startDocument()
void	startElement(java.lang.Object type)
void	startHiderSection(boolean show) Start section controled by a show/hide button.
void	startLogicalBlock(java.lang.String prefix, boolean perLine, java.lang.String suffix)
static void	startLogicalBlock(java.lang.String prefix, boolean perLine, java.lang.String suffix, Consumer out)
void	startLogicalBlock(java.lang.String prefix, java.lang.String suffix, int indent)
protected void	startNumber()
void	write(java.lang.CharSequence csq, int start, int length)
void	writeBoolean(boolean v)
void	writeBreak(int kind)
void	writeBreakFill()
static void	writeBreakFill(Consumer out)
void	writeBreakLinear() Write a new-line iff the containing section cannot be printed on one line.
void	writeCDATA(char[] chars, int offset, int length)
void	writeComment(char[] chars, int offset, int length)
void	writeDouble(double v)
void	writeFloat(float v)
void	writeInt(int v)
void	writeLong(long v)
void	writeObject(java.lang.Object v)
void	writeProcessingInstruction(java.lang.String target, char[] content, int offset, int length)
protected void	writeRaw(char[] chars, int start, int length)
protected void	writeRaw(int v)
protected void	writeRaw(java.lang.String str)
protected void	writeRaw(java.lang.String str, int start, int length)
void	writeShowHideButton(boolean show) If supported (i.e.
void	writeSpace(int kind)
void	writeSpaceFill()
static void	writeSpaceFill(Consumer out)
void	writeSpaceLinear()
void	writeWordEnd()
void	writeWordStart()

Methods inherited from class java.io.PrintWriter

checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gnu.lists.Consumer

accept, accept, accept, accept, write, write, write

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface java.util.function.IntConsumer

andThen

Methods inherited from interface java.util.function.LongConsumer

andThen

Methods inherited from interface java.util.function.DoubleConsumer

andThen

Field Detail

skipping

protected boolean skipping

base

protected Consumer base

Constructor Detail

PrintConsumer

public PrintConsumer(java.io.Writer out)

PrintConsumer

public PrintConsumer(java.io.Writer out,
                     boolean autoFlush)

PrintConsumer

public PrintConsumer(Consumer out,
                     boolean autoFlush)

PrintConsumer

public PrintConsumer(java.io.OutputStream out,
                     boolean autoFlush)

Method Detail

getPrettyWriter

public gnu.kawa.io.PrettyWriter getPrettyWriter()

startNumber

protected void startNumber()

endNumber

protected void endNumber()

append

public PrintConsumer append(char c)

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.PrintWriter

append

public PrintConsumer append(java.lang.CharSequence csq)

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.PrintWriter

append

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

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.PrintWriter

write

public void write(java.lang.CharSequence csq,
                  int start,
                  int length)

freshLine

public void freshLine()

writeSpace

public void writeSpace(int kind)

writeBreak

public void writeBreak(int kind)

writeBreakFill

public static void writeBreakFill(Consumer out)

writeBreakFill

public void writeBreakFill()

writeSpaceFill

public static void writeSpaceFill(Consumer out)

writeSpaceFill

public void writeSpaceFill()

writeSpaceLinear

public void writeSpaceLinear()

writeBreakLinear

public void writeBreakLinear()

Write a new-line iff the containing section cannot be printed on one line. Either all linear-style newlines in a logical block becomes spaces (if it all fits in a line), or none of them do.

setIndentation

public void setIndentation(int amount,
                           boolean current)

isDomTerm

public boolean isDomTerm()

writeShowHideButton

public void writeShowHideButton(boolean show)

If supported (i.e. on DomTerm), "print" a show/hide button.

startHiderSection

public void startHiderSection(boolean show)

Start section controled by a show/hide button. Must be properly nested within/around logical blocks. Current only supported on DomTerm.

endHiderSection

public void endHiderSection()

End section controled by a show/hide button

startLogicalBlock

public static void startLogicalBlock(java.lang.String prefix,
                                     boolean perLine,
                                     java.lang.String suffix,
                                     Consumer out)

startLogicalBlock

public void startLogicalBlock(java.lang.String prefix,
                              boolean perLine,
                              java.lang.String suffix)

startLogicalBlock

public void startLogicalBlock(java.lang.String prefix,
                              java.lang.String suffix,
                              int indent)

endLogicalBlock

public static void endLogicalBlock(java.lang.String suffix,
                                   Consumer out)

endLogicalBlock

public void endLogicalBlock(java.lang.String suffix)

beforeContent

protected void beforeContent()

beforeNode

protected void beforeNode()

writeWordStart

public void writeWordStart()

writeWordEnd

public void writeWordEnd()

clearWordEnd

protected void clearWordEnd()

writeBoolean

public void writeBoolean(boolean v)

writeFloat

public void writeFloat(float v)

writeDouble

public void writeDouble(double v)

writeInt

public void writeInt(int v)

writeLong

public void writeLong(long v)

startDocument

public void startDocument()

endDocument

public void endDocument()

startElement

public void startElement(java.lang.Object type)

endElement

public void endElement()

startAttribute

public void startAttribute(java.lang.Object attrType)

Description copied from interface: Consumer

Write a attribute for the current element. This is only allowed immediately after a startElement.

endAttribute

public void endAttribute()

Description copied from interface: Consumer

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.

writeComment

public void writeComment(char[] chars,
                         int offset,
                         int length)

Specified by:

writeComment in interface XConsumer

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String target,
                                       char[] content,
                                       int offset,
                                       int length)

Specified by:

writeProcessingInstruction in interface XConsumer

writeCDATA

public void writeCDATA(char[] chars,
                       int offset,
                       int length)

Specified by:

writeCDATA in interface XConsumer

beginEntity

public void beginEntity(java.lang.Object baseUri)

Specified by:

beginEntity in interface XConsumer

endEntity

public void endEntity()

Specified by:

endEntity in interface XConsumer

writeRaw

protected void writeRaw(int v)

writeRaw

protected void writeRaw(java.lang.String str)

writeRaw

protected void writeRaw(java.lang.String str,
                        int start,
                        int length)

writeRaw

protected void writeRaw(char[] chars,
                        int start,
                        int length)

writeObject

public void writeObject(java.lang.Object v)

ignoring

public boolean ignoring()

Description copied from interface: Consumer

True if consumer is ignoring rest of element. The producer can use this information to skip ahead.