gnu.kawa.xml

Class HttpPrinter

java.lang.Object

java.io.Writer

java.io.PrintWriter

gnu.lists.PrintConsumer

gnu.kawa.xml.HttpPrinter

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:

ServletPrinter

public class HttpPrinter
extends PrintConsumer

Output as an Http response. Used for both CGI scripts (default) and HttpServletResponse (future).

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.OutputStream	ostream
protected java.lang.String	sawContentType

Fields inherited from class gnu.lists.PrintConsumer

base, skipping

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
HttpPrinter(java.io.OutputStream out)
HttpPrinter(PrintConsumer out)

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String label, java.lang.String value)
protected void	beforeNode()
void	beginData()
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.
static HttpPrinter	make(PrintConsumer out)
void	printHeader(java.lang.String label, java.lang.String value)
void	printHeaders()
boolean	reset(boolean headersAlso) Try to reset (delete) any response generated so far.
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 off, int len)
void	write(java.lang.CharSequence str, int start, int length)
void	writeObject(java.lang.Object v)

Methods inherited from class gnu.lists.PrintConsumer

append, append, append, beforeContent, beginEntity, clearWordEnd, endEntity, endHiderSection, endLogicalBlock, endLogicalBlock, endNumber, freshLine, getPrettyWriter, isDomTerm, setIndentation, startHiderSection, startLogicalBlock, startLogicalBlock, startLogicalBlock, startNumber, writeBoolean, writeBreak, writeBreakFill, writeBreakFill, writeBreakLinear, writeCDATA, writeComment, writeDouble, writeFloat, writeInt, writeLong, writeProcessingInstruction, writeRaw, writeRaw, writeRaw, writeRaw, writeShowHideButton, writeSpace, writeSpaceFill, writeSpaceFill, writeSpaceLinear, writeWordEnd, 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

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

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

sawContentType

protected java.lang.String sawContentType

ostream

protected java.io.OutputStream ostream

Constructor Detail

HttpPrinter

public HttpPrinter(java.io.OutputStream out)

HttpPrinter

public HttpPrinter(PrintConsumer out)

Method Detail

make

public static HttpPrinter make(PrintConsumer out)

beforeNode

protected void beforeNode()

Overrides:

beforeNode in class PrintConsumer

printHeader

public void printHeader(java.lang.String label,
                        java.lang.String value)
                 throws java.io.IOException

Throws:

java.io.IOException

printHeaders

public void printHeaders()
                  throws java.io.IOException

Throws:

java.io.IOException

addHeader

public void addHeader(java.lang.String label,
                      java.lang.String value)

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.

Overrides:

startAttribute in class PrintConsumer

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.

Overrides:

endAttribute in class PrintConsumer

beginData

public void beginData()

startElement

public void startElement(java.lang.Object type)

Overrides:

startElement in class PrintConsumer

endElement

public void endElement()

Overrides:

endElement in class PrintConsumer

writeObject

public void writeObject(java.lang.Object v)

Overrides:

writeObject in class PrintConsumer

write

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

Overrides:

write in class PrintConsumer

write

public void write(char[] buf,
                  int off,
                  int len)

Overrides:

write in class java.io.PrintWriter

startDocument

public void startDocument()

Overrides:

startDocument in class PrintConsumer

endDocument

public void endDocument()

Overrides:

endDocument in class PrintConsumer

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.

Overrides:

ignoring in class PrintConsumer

reset

public boolean reset(boolean headersAlso)

Try to reset (delete) any response generated so far.

Parameters:

headersAlso - if response headers should also be reset.

Returns:

true on success, false if it's too late.