public class XMLEmitter extends Emitter
Modifier and Type | Field and Description |
---|---|
protected boolean[] |
attSpecials |
protected CharacterReferenceGenerator |
characterReferenceGenerator |
protected boolean |
declarationIsWritten |
protected char |
delimiter |
protected NodeName |
elementCode |
protected java.util.Stack<java.lang.String> |
elementStack |
protected int |
indentForNextAttribute |
protected boolean |
openStartTag |
protected boolean |
started |
protected boolean |
startedElement |
protected boolean |
undeclareNamespaces |
protected boolean |
unfailing |
allCharactersEncodable, characterSet, outputProperties, outputStream, streamResult, writer
pipelineConfiguration, previousAtomic, systemId
Constructor and Description |
---|
XMLEmitter() |
Modifier and Type | Method and Description |
---|---|
void |
attribute(NodeName nameCode,
SimpleType typeCode,
java.lang.CharSequence value,
Location locationId,
int properties)
Notify an attribute.
|
void |
characters(java.lang.CharSequence chars,
Location locationId,
int properties)
Character data.
|
void |
close()
End of the document.
|
void |
closeStartTag()
Mark the end of the start tag
|
void |
comment(java.lang.CharSequence chars,
Location locationId,
int properties)
Handle a comment.
|
protected java.lang.String |
convertToAscii(java.lang.CharSequence chars)
Where characters are not available in the selected encoding, substitute them
|
protected java.lang.String |
emptyElementTagCloser(java.lang.String displayName,
NodeName nameCode)
Close an empty element tag.
|
void |
endDocument()
Notify the end of a document node
|
void |
endElement()
End of an element.
|
protected java.lang.String |
getAttributeIndentString() |
boolean |
isStarted()
Ask whether anything has yet been written
|
void |
namespace(NamespaceBindingSet namespaceBindings,
int properties)
Notify one or more namespaces.
|
void |
open()
Start of the event stream.
|
protected void |
openDocument()
Do the real work of starting the document.
|
void |
processingInstruction(java.lang.String target,
java.lang.CharSequence data,
Location locationId,
int properties)
Handle a processing instruction.
|
void |
setCharacterReferenceGenerator(CharacterReferenceGenerator generator)
Set the character reference generator to be used for generating hexadecimal or decimal
character references
|
void |
setEscapeNonAscii(java.lang.Boolean escape)
Say that all non-ASCII characters should be escaped, regardless of the character encoding
|
void |
setIndentForNextAttribute(int indent) |
void |
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.
|
void |
startDocument(int properties)
Start of a document node.
|
void |
startElement(NodeName elemName,
SchemaType typeCode,
Location location,
int properties)
Start of an element.
|
protected int |
testCharacters(java.lang.CharSequence chars)
Test that all characters in a name (for example) are supported in the target encoding.
|
boolean |
usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations
supplied on element and attribute events
|
protected void |
writeAttribute(NodeName elCode,
java.lang.String attname,
java.lang.CharSequence value,
int properties)
Write attribute name=value pair.
|
void |
writeCharSequence(java.lang.CharSequence s)
Write a CharSequence (without any escaping of special characters): various implementations
|
void |
writeDeclaration()
Output the XML declaration
|
protected void |
writeDocType(NodeName name,
java.lang.String displayName,
java.lang.String systemId,
java.lang.String publicId)
Output the document type declaration
|
protected boolean |
writeDocTypeWithNullSystemId() |
protected void |
writeEscape(java.lang.CharSequence chars,
boolean inAttribute)
Write contents of array to current writer, after escaping special characters.
|
append, getOutputProperties, getOutputStream, getWriter, makeOutputStream, makeWriter, setOutputProperties, setOutputStream, setStreamResult, setUnparsedEntity, setWriter, usesWriter
append, getConfiguration, getNamePool, getPipelineConfiguration, getSystemId, isTrueSequenceReceiver, setPipelineConfiguration, setSystemId
protected boolean started
protected boolean startedElement
protected boolean openStartTag
protected boolean declarationIsWritten
protected NodeName elementCode
protected int indentForNextAttribute
protected boolean undeclareNamespaces
protected boolean unfailing
protected char delimiter
protected boolean[] attSpecials
protected java.util.Stack<java.lang.String> elementStack
protected CharacterReferenceGenerator characterReferenceGenerator
public void setCharacterReferenceGenerator(CharacterReferenceGenerator generator)
generator
- the character reference generator to be usedpublic void setEscapeNonAscii(java.lang.Boolean escape)
escape
- true if all non ASCII characters should be escapedpublic void open() throws XPathException
open
in interface Receiver
open
in class SequenceReceiver
XPathException
- if an error occurspublic void startDocument(int properties) throws XPathException
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occurspublic void endDocument() throws XPathException
XPathException
- if an error occursprotected void openDocument() throws XPathException
XPathException
- f an error occurs opening the output filepublic void writeDeclaration() throws XPathException
XPathException
protected void writeDocType(NodeName name, java.lang.String displayName, java.lang.String systemId, java.lang.String publicId) throws XPathException
name
- the qualified name of the elementdisplayName
- The element name as displayedsystemId
- The DOCTYPE system identifierpublicId
- The DOCTYPE public identifierXPathException
- if an error occurs writing to the outputpublic void close() throws XPathException
close
in interface Receiver
close
in class Emitter
XPathException
- if an error occurspublic void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
elemName
- the name of the element.typeCode
- the type annotation of the element.location
- an object providing information about the module, line, and column where the node originatedproperties
- bit-significant properties of the element node. If there are no revelant
properties, zero is supplied. The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occursprotected boolean writeDocTypeWithNullSystemId()
public void namespace(NamespaceBindingSet namespaceBindings, int properties) throws XPathException
Receiver
namespaceBindings
- contains the namespace prefix and namespace URIproperties
- The most important property is REJECT_DUPLICATES. If this property is set, the
namespace declaration will be rejected if it conflicts with a previous declaration of the same
prefix. If the property is not set, the namespace declaration will be ignored if it conflicts
with a previous declaration. This reflects the fact that when copying a tree, namespaces for child
elements are emitted before the namespaces of their parent element. Unfortunately this conflicts
with the XSLT rule for complex content construction, where the recovery action in the event of
conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:XPathException
- if an error occurspublic void setIndentForNextAttribute(int indent)
public void attribute(NodeName nameCode, SimpleType typeCode, java.lang.CharSequence value, Location locationId, int properties) throws XPathException
Receiver
nameCode
- The name of the attributetypeCode
- The type annotation of the attributevalue
- the string value of the attributelocationId
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occursprotected java.lang.String getAttributeIndentString()
public void startContent() throws XPathException
Receiver
XPathException
- if an error occurspublic void closeStartTag() throws XPathException
XPathException
- if an IO exception occursprotected java.lang.String emptyElementTagCloser(java.lang.String displayName, NodeName nameCode)
displayName
- the name of the empty elementnameCode
- the fingerprint of the name of the empty elementprotected void writeAttribute(NodeName elCode, java.lang.String attname, java.lang.CharSequence value, int properties) throws XPathException
elCode
- The element name is not used in this version of the
method, but is used in the HTML subclass.attname
- The attribute name, which has already been validated to ensure
it can be written in this encodingvalue
- The value of the attributeproperties
- Any special properties of the attributeXPathException
- if an error occursprotected int testCharacters(java.lang.CharSequence chars) throws XPathException
chars
- the characters to be testedXPathException
protected java.lang.String convertToAscii(java.lang.CharSequence chars)
public void endElement() throws XPathException
XPathException
- if an error occurspublic void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathException
chars
- The characterslocationId
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void writeCharSequence(java.lang.CharSequence s) throws java.io.IOException
s
- the character sequence to be writtenjava.io.IOException
- in the event of a failure to write to the output filepublic void processingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) throws XPathException
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- provides information such as line number and system ID.properties
- Additional information about the PI.XPathException
- if an error occursprotected void writeEscape(java.lang.CharSequence chars, boolean inAttribute) throws java.io.IOException, XPathException
chars
- The character sequence containing the stringinAttribute
- Set to true if the text is in an attribute valuejava.io.IOException
XPathException
public void comment(java.lang.CharSequence chars, Location locationId, int properties) throws XPathException
chars
- The content of the commentlocationId
- provides information such as line number and system ID.properties
- Additional information about the comment.XPathException
- if an error occurspublic boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
usesTypeAnnotations
in class Emitter
public boolean isStarted()
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.