gnu.xml

Class XMLPrinter

public class XMLPrinter extends OutPort implements PositionConsumer, XConsumer

Print an event stream in XML format on a PrintWriter.

Field Summary
boolean	canonicalizeCDATA
static ThreadLocation	doctypePublic The system identifier emitted in a DOCTYPE declaration.
static ThreadLocation	doctypeSystem Fluid parameter to control whether a DOCTYPE declaration is emitted.
boolean	escapeNonAscii
boolean	escapeText
boolean	indentAttributes When indentating, should attributes be lined up?
static ThreadLocation	indentLoc
int	printIndent Controls whether to add extra indentation.
boolean	strict
int	useEmptyElementTag Handling of empty elements.

Constructor Summary
	XMLPrinter(OutPort out, boolean autoFlush)
	XMLPrinter(Writer out, boolean autoFlush)
	XMLPrinter(OutputStream out, boolean autoFlush)
	XMLPrinter(Writer out)
	XMLPrinter(OutputStream out)
	XMLPrinter(OutputStream out, Path path)

Method Summary
void	beginComment()
void	beginEntity(Object base)
void	closeTag()
void	consume(SeqPosition position)
void	endAttribute()
void	endComment()
void	endDocument()
void	endElement()
void	endEntity()
protected void	endNumber()
void	error(String msg, String code)
static String	formatDecimal(BigDecimal dec) Format java.math.BigDecimal as needed for XPath/XQuery's xs:decimal.
static String	formatDouble(double d) Helper to format xs:double according to XPath/XQuery specification.
static String	formatFloat(float f) Helper to format xs:float according to XPath/XQuery specification.
boolean	ignoring() True if consumer is ignoring rest of element.
static boolean	isHtmlEmptyElementTag(String name)
static XMLPrinter	make(OutPort out, Object style)
void	print(Object v)
void	setPrintXMLdecl(boolean value)
void	setStyle(Object style)
void	startAttribute(Object attrType) Write a attribute for the current element.
void	startDocument()
void	startElement(Object type)
protected void	startNumber()
static String	toString(Object value) Convert argument to string in XML syntax.
void	write(int v)
void	write(String str, int start, int length)
void	write(char[] buf, int off, int len)
void	writeBaseUri(Object uri)
void	writeBoolean(boolean v)
void	writeCDATA(char[] chars, int offset, int length)
void	writeComment(String chars)
void	writeComment(char[] chars, int offset, int length)
void	writeDouble(double d)
void	writeFloat(float f)
void	writeObject(Object v)
void	writePosition(AbstractSequence seq, int ipos)
void	writeProcessingInstruction(String target, char[] content, int offset, int length)
protected void	writeQName(Object name)

Field Detail

doctypePublic

public static final ThreadLocation doctypePublic

The system identifier emitted in a DOCTYPE declaration. Has no effect if doctypeSystem returns null. If non-null, this is the the system identifier.

doctypeSystem

public static final ThreadLocation doctypeSystem

Fluid parameter to control whether a DOCTYPE declaration is emitted. If non-null, this is the the public identifier.

indentAttributes

public boolean indentAttributes

When indentating, should attributes be lined up?

indentLoc

public static final ThreadLocation indentLoc

printIndent

public int printIndent

Controls whether to add extra indentation. -1: don't add indentation; 0: pretty-print (avoid needless newlines); 1: indent (force).

useEmptyElementTag

public int useEmptyElementTag

Handling of empty elements. 0: No element element tags, as required for canonical XML: {@code

}. 1: Use XML-style empty element tags: {@code
} 2: Use HTML-compatible empty element tags: {@code
}

Constructor Detail

XMLPrinter

public XMLPrinter(OutPort out, boolean autoFlush)

XMLPrinter

public XMLPrinter(Writer out, boolean autoFlush)

XMLPrinter

public XMLPrinter(OutputStream out, boolean autoFlush)

XMLPrinter

public XMLPrinter(OutputStream out, Path path)

Method Detail

consume

public void consume(SeqPosition position)

error

public void error(String msg, String code)

formatDecimal

public static String formatDecimal(BigDecimal dec)

Format java.math.BigDecimal as needed for XPath/XQuery's xs:decimal. Specifically this means removing trailing fractional zeros, and a trailing decimal point. However, note that the XML Schema canonical representation does require a decimal point and at least one fractional digit.