Package net.sf.saxon.event
Class StreamWriterToReceiver
- java.lang.Object
-
- net.sf.saxon.event.StreamWriterToReceiver
-
- All Implemented Interfaces:
javax.xml.stream.XMLStreamWriter
- Direct Known Subclasses:
BuildingStreamWriterImpl
public class StreamWriterToReceiver extends java.lang.Object implements javax.xml.stream.XMLStreamWriter
This class implements the XmlStreamWriter interface, translating the events into Saxon Receiver events. The Receiver can be anything: a serializer, a schema validator, a tree builder.The class will attempt to generate namespace prefixes where none have been supplied, unless the
method should be called only if there is a need to declare a namespace prefix that is not used on any element or attribute name.inventPrefixes
option is set to false. The preferred mode of use is to call the versions ofwriteStartElement
andwriteAttribute
that supply the prefix, URI, and local name in full. If the prefix is omitted, the class attempts to invent a prefix. If the URI is omitted, the name is assumed to be in no namespace. ThewriteNamespace
The class will check all names, URIs, and character content for conformance against XML well-formedness rules unless the
checkValues
option is set to false.- Since:
- 9.3
-
-
Constructor Summary
Constructors Constructor Description StreamWriterToReceiver(Receiver receiver)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
void
flush()
javax.xml.namespace.NamespaceContext
getNamespaceContext()
java.lang.String
getPrefix(java.lang.String uri)
java.lang.Object
getProperty(java.lang.String name)
boolean
isCheckValues()
Ask whether names and values are to be checked for conformance with XML rulesboolean
isInventPrefixes()
Ask whether prefixes are to be invented when none is specified by the uservoid
setCheckValues(boolean check)
Say whether names and values are to be checked for conformance with XML rulesvoid
setDefaultNamespace(java.lang.String uri)
void
setInventPrefixes(boolean invent)
Say whether prefixes are to be invented when none is specified by the uservoid
setNamespaceContext(javax.xml.namespace.NamespaceContext context)
void
setPrefix(java.lang.String prefix, java.lang.String uri)
void
writeAttribute(java.lang.String localName, java.lang.String value)
void
writeAttribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
void
writeAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
void
writeCData(java.lang.String data)
void
writeCharacters(char[] text, int start, int len)
void
writeCharacters(java.lang.String text)
void
writeComment(java.lang.String data)
void
writeDefaultNamespace(java.lang.String namespaceURI)
void
writeDTD(java.lang.String dtd)
void
writeEmptyElement(java.lang.String localName)
void
writeEmptyElement(java.lang.String namespaceURI, java.lang.String localName)
void
writeEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
void
writeEndDocument()
void
writeEndElement()
void
writeEntityRef(java.lang.String name)
void
writeNamespace(java.lang.String prefix, java.lang.String namespaceURI)
void
writeProcessingInstruction(java.lang.String target)
void
writeProcessingInstruction(java.lang.String target, java.lang.String data)
void
writeStartDocument()
void
writeStartDocument(java.lang.String version)
void
writeStartDocument(java.lang.String encoding, java.lang.String version)
void
writeStartElement(java.lang.String localName)
void
writeStartElement(java.lang.String namespaceURI, java.lang.String localName)
void
writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
-
-
-
Constructor Detail
-
StreamWriterToReceiver
public StreamWriterToReceiver(Receiver receiver)
Constructor. Creates a StreamWriter as a front-end to a given Receiver.- Parameters:
receiver
- the Receiver that is to receive the events generated by this StreamWriter.
-
-
Method Detail
-
setInventPrefixes
public void setInventPrefixes(boolean invent)
Say whether prefixes are to be invented when none is specified by the user- Parameters:
invent
- true if prefixes are to be invented. Default is true;
-
isInventPrefixes
public boolean isInventPrefixes()
Ask whether prefixes are to be invented when none is specified by the user- Returns:
- true if prefixes are to be invented. Default is true;
-
setCheckValues
public void setCheckValues(boolean check)
Say whether names and values are to be checked for conformance with XML rules- Parameters:
check
- true if names and values are to be checked. Default is true;
-
isCheckValues
public boolean isCheckValues()
Ask whether names and values are to be checked for conformance with XML rules- Returns:
- true if names and values are to be checked. Default is true;
-
writeStartElement
public void writeStartElement(java.lang.String localName) throws javax.xml.stream.XMLStreamException
- Specified by:
writeStartElement
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeStartElement
public void writeStartElement(java.lang.String namespaceURI, java.lang.String localName) throws javax.xml.stream.XMLStreamException
- Specified by:
writeStartElement
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeStartElement
public void writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
- Specified by:
writeStartElement
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(java.lang.String namespaceURI, java.lang.String localName) throws javax.xml.stream.XMLStreamException
- Specified by:
writeEmptyElement
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
- Specified by:
writeEmptyElement
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(java.lang.String localName) throws javax.xml.stream.XMLStreamException
- Specified by:
writeEmptyElement
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeEndElement
public void writeEndElement() throws javax.xml.stream.XMLStreamException
- Specified by:
writeEndElement
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeEndDocument
public void writeEndDocument() throws javax.xml.stream.XMLStreamException
- Specified by:
writeEndDocument
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
close
public void close() throws javax.xml.stream.XMLStreamException
- Specified by:
close
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
flush
public void flush() throws javax.xml.stream.XMLStreamException
- Specified by:
flush
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeAttribute
public void writeAttribute(java.lang.String localName, java.lang.String value) throws javax.xml.stream.XMLStreamException
- Specified by:
writeAttribute
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeAttribute
public void writeAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) throws javax.xml.stream.XMLStreamException
- Specified by:
writeAttribute
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeAttribute
public void writeAttribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) throws javax.xml.stream.XMLStreamException
- Specified by:
writeAttribute
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeNamespace
public void writeNamespace(java.lang.String prefix, java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
- Specified by:
writeNamespace
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeDefaultNamespace
public void writeDefaultNamespace(java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
- Specified by:
writeDefaultNamespace
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeComment
public void writeComment(java.lang.String data) throws javax.xml.stream.XMLStreamException
- Specified by:
writeComment
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeProcessingInstruction
public void writeProcessingInstruction(java.lang.String target) throws javax.xml.stream.XMLStreamException
- Specified by:
writeProcessingInstruction
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeProcessingInstruction
public void writeProcessingInstruction(java.lang.String target, java.lang.String data) throws javax.xml.stream.XMLStreamException
- Specified by:
writeProcessingInstruction
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeCData
public void writeCData(java.lang.String data) throws javax.xml.stream.XMLStreamException
- Specified by:
writeCData
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeDTD
public void writeDTD(java.lang.String dtd) throws javax.xml.stream.XMLStreamException
- Specified by:
writeDTD
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeEntityRef
public void writeEntityRef(java.lang.String name) throws javax.xml.stream.XMLStreamException
- Specified by:
writeEntityRef
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeStartDocument
public void writeStartDocument() throws javax.xml.stream.XMLStreamException
- Specified by:
writeStartDocument
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeStartDocument
public void writeStartDocument(java.lang.String version) throws javax.xml.stream.XMLStreamException
- Specified by:
writeStartDocument
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeStartDocument
public void writeStartDocument(java.lang.String encoding, java.lang.String version) throws javax.xml.stream.XMLStreamException
- Specified by:
writeStartDocument
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeCharacters
public void writeCharacters(java.lang.String text) throws javax.xml.stream.XMLStreamException
- Specified by:
writeCharacters
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
writeCharacters
public void writeCharacters(char[] text, int start, int len) throws javax.xml.stream.XMLStreamException
- Specified by:
writeCharacters
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
getPrefix
public java.lang.String getPrefix(java.lang.String uri)
- Specified by:
getPrefix
in interfacejavax.xml.stream.XMLStreamWriter
-
setPrefix
public void setPrefix(java.lang.String prefix, java.lang.String uri)
- Specified by:
setPrefix
in interfacejavax.xml.stream.XMLStreamWriter
-
setDefaultNamespace
public void setDefaultNamespace(java.lang.String uri) throws javax.xml.stream.XMLStreamException
- Specified by:
setDefaultNamespace
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
setNamespaceContext
public void setNamespaceContext(javax.xml.namespace.NamespaceContext context) throws javax.xml.stream.XMLStreamException
- Specified by:
setNamespaceContext
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
javax.xml.stream.XMLStreamException
-
getNamespaceContext
public javax.xml.namespace.NamespaceContext getNamespaceContext()
- Specified by:
getNamespaceContext
in interfacejavax.xml.stream.XMLStreamWriter
-
getProperty
public java.lang.Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException
- Specified by:
getProperty
in interfacejavax.xml.stream.XMLStreamWriter
- Throws:
java.lang.IllegalArgumentException
-
-