Top Fields Constructors Methods
org.codehaus.jettison.badgerfish

public Class BadgerFishXMLStreamWriter

extends AbstractXMLStreamWriter
Class Inheritance
Imports
java.io.IOException, .Writer, javax.xml.namespace.NamespaceContext, javax.xml.stream.XMLStreamException, org.codehaus.jettison.AbstractXMLStreamWriter, .Node, .XsonNamespaceContext, org.codehaus.jettison.json.JSONArray, .JSONException, .JSONObject, org.codehaus.jettison.util.FastStack

Field Summary

Modifier and TypeField and Description
private NamespaceContext
ctx

private String
currentKey

private JSONObject
currentNode

private FastStack
nodes

private JSONObject
root

private Writer
writer

Constructor Summary

AccessConstructor and Description
public
BadgerFishXMLStreamWriter(Writer writer)

public
BadgerFishXMLStreamWriter(Writer writer, JSONObject currentNode)

public
BadgerFishXMLStreamWriter(Writer writer, JSONObject currentNode, FastStack nodes)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements javax.xml.stream.XMLStreamWriter.close.

Close this writer and free any resources associated with the writer.
private String
createAttributeKey(String p, String ns, String local)

private String
createKey(String p, String ns, String local)

public void
flush()

Implements javax.xml.stream.XMLStreamWriter.flush.

Write any cached data to the underlying output mechanism.
protected JSONObject
getCurrentNode()

public NamespaceContext
getNamespaceContext()

Implements javax.xml.stream.XMLStreamWriter.getNamespaceContext.

Returns the current namespace context.
protected FastStack
getNodes()

public String
getPrefix(String
the uri the prefix is bound to
ns)

Implements javax.xml.stream.XMLStreamWriter.getPrefix.

Gets the prefix the uri is bound to.
public Object
getProperty(String
The name of the property, may not be null
arg0)

Implements javax.xml.stream.XMLStreamWriter.getProperty.

Get the value of a feature/property from the underlying implementation
public void
setDefaultNamespace(String
the uri to bind to the default namespace, may be null
arg0)

Implements javax.xml.stream.XMLStreamWriter.setDefaultNamespace.

Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair.
public void
setNamespaceContext(NamespaceContext
the namespace context to use for this writer, may not be null
context)

Implements javax.xml.stream.XMLStreamWriter.setNamespaceContext.

Sets the current namespace context for prefix and uri bindings.
public void
setPrefix(String
the prefix to bind to the uri, may not be null
arg0, String
the uri to bind to the prefix, may be null
arg1)

Implements javax.xml.stream.XMLStreamWriter.setPrefix.

Sets the prefix the uri is bound to.
public void
writeAttribute(String
the prefix for this attribute
p, String
the uri of the prefix for this attribute
ns, String
the local name of the attribute
local, String
the value of the attribute
value)

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream
public void
writeAttribute(String
the uri of the prefix for this attribute
ns, String
the local name of the attribute
local, String
the value of the attribute
value)

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream
public void
writeAttribute(String
the local name of the attribute
local, String
the value of the attribute
value)

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream without a prefix.
public void
writeCharacters(String
the value to write
text)

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output
public void
writeDefaultNamespace(String
the uri to bind the default namespace to
ns)

Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

Writes the default namespace to the stream
public void
writeEndDocument()

Overrides org.codehaus.jettison.AbstractXMLStreamWriter.writeEndDocument.

Implements javax.xml.stream.XMLStreamWriter.writeEndDocument.

Closes any start tags and writes corresponding end tags.
public void
writeEndElement()

Implements javax.xml.stream.XMLStreamWriter.writeEndElement.

Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.
public void
writeEntityRef(String
the name of the entity
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeEntityRef.

Writes an entity reference
public void
writeNamespace(String
the prefix to bind this namespace to
prefix, String
the uri to bind the prefix to
ns)

Implements javax.xml.stream.XMLStreamWriter.writeNamespace.

Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace
public void
writeProcessingInstruction(String
the target of the processing instruction, may not be null
arg0, String
the data contained in the processing instruction, may not be null
arg1)

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Writes a processing instruction
public void
writeProcessingInstruction(String
the target of the processing instruction, may not be null
arg0)

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Writes a processing instruction
public void
writeStartDocument()

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration.
public void
writeStartElement(String
the prefix of the tag, may not be null
prefix, String
local name of the tag, may not be null
local, String
the uri to bind the prefix to, may not be null
ns)

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output
Inherited from org.codehaus.jettison.AbstractXMLStreamWriter:
getSerializedAsArraysisArrayKeysWithSlashAvailableserializeAsArrayseriliazeAsArraywriteCDatawriteCharacterswriteCommentwriteDTDwriteEmptyElementwriteEmptyElementwriteEmptyElementwriteStartDocumentwriteStartDocumentwriteStartElementwriteStartElement

Field Detail

ctxback to summary
private NamespaceContext ctx
currentKeyback to summary
private String currentKey
currentNodeback to summary
private JSONObject currentNode
nodesback to summary
private FastStack nodes
rootback to summary
private JSONObject root
writerback to summary
private Writer writer

Constructor Detail

BadgerFishXMLStreamWriterback to summary
public BadgerFishXMLStreamWriter(Writer writer)
BadgerFishXMLStreamWriterback to summary
public BadgerFishXMLStreamWriter(Writer writer, JSONObject currentNode)
BadgerFishXMLStreamWriterback to summary
public BadgerFishXMLStreamWriter(Writer writer, JSONObject currentNode, FastStack nodes)

Method Detail

closeback to summary
public void close() throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.close.

Doc from javax.xml.stream.XMLStreamWriter.close.

Close this writer and free any resources associated with the writer. This must not close the underlying output stream.

Exceptions
XMLStreamException:
if an error occurs
createAttributeKeyback to summary
private String createAttributeKey(String p, String ns, String local)
createKeyback to summary
private String createKey(String p, String ns, String local)
flushback to summary
public void flush() throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.flush.

Doc from javax.xml.stream.XMLStreamWriter.flush.

Write any cached data to the underlying output mechanism.

Exceptions
XMLStreamException:
if an error occurs
getCurrentNodeback to summary
protected JSONObject getCurrentNode()
getNamespaceContextback to summary
public NamespaceContext getNamespaceContext()

Implements javax.xml.stream.XMLStreamWriter.getNamespaceContext.

Doc from javax.xml.stream.XMLStreamWriter.getNamespaceContext.

Returns the current namespace context.

Returns:NamespaceContext

the current NamespaceContext

getNodesback to summary
protected FastStack getNodes()
getPrefixback to summary
public String getPrefix(String ns) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.getPrefix.

Doc from javax.xml.stream.XMLStreamWriter.getPrefix.

Gets the prefix the uri is bound to.

Parameters
ns:String

the uri the prefix is bound to

Returns:String

the prefix or null

Exceptions
XMLStreamException:
if an error occurs
getPropertyback to summary
public Object getProperty(String arg0) throws IllegalArgumentException

Implements javax.xml.stream.XMLStreamWriter.getProperty.

Doc from javax.xml.stream.XMLStreamWriter.getProperty.

Get the value of a feature/property from the underlying implementation

Parameters
arg0:String

The name of the property, may not be null

Returns:Object

The value of the property

Exceptions
IllegalArgumentException:
if the property is not supported
setDefaultNamespaceback to summary
public void setDefaultNamespace(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.setDefaultNamespace.

Doc from javax.xml.stream.XMLStreamWriter.setDefaultNamespace.

Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the uri is bound in the root scope.

Parameters
arg0:String

the uri to bind to the default namespace, may be null

Exceptions
XMLStreamException:
if an error occurs
setNamespaceContextback to summary
public void setNamespaceContext(NamespaceContext context) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.setNamespaceContext.

Doc from javax.xml.stream.XMLStreamWriter.setNamespaceContext.

Sets the current namespace context for prefix and uri bindings. This context becomes the root namespace context for writing and will replace the current root namespace context. Subsequent calls to setPrefix and setDefaultNamespace will bind namespaces using the context passed to the method as the root context for resolving namespaces. This method may only be called once at the start of the document. It does not cause the namespaces to be declared. If a namespace URI to prefix mapping is found in the namespace context it is treated as declared and the prefix may be used by the StreamWriter.

Parameters
context:NamespaceContext

the namespace context to use for this writer, may not be null

Exceptions
XMLStreamException:
if an error occurs
setPrefixback to summary
public void setPrefix(String arg0, String arg1) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.setPrefix.

Doc from javax.xml.stream.XMLStreamWriter.setPrefix.

Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the prefix is bound in the root scope.

Parameters
arg0:String

the prefix to bind to the uri, may not be null

arg1:String

the uri to bind to the prefix, may be null

Exceptions
XMLStreamException:
if an error occurs
writeAttributeback to summary
public void writeAttribute(String p, String ns, String local, String value) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Doc from javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream

Parameters
p:String

the prefix for this attribute

ns:String

the uri of the prefix for this attribute

local:String

the local name of the attribute

value:String

the value of the attribute

Exceptions
XMLStreamException:
if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true
writeAttributeback to summary
public void writeAttribute(String ns, String local, String value) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Doc from javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream

Parameters
ns:String

the uri of the prefix for this attribute

local:String

the local name of the attribute

value:String

the value of the attribute

Exceptions
XMLStreamException:
if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true
writeAttributeback to summary
public void writeAttribute(String local, String value) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeAttribute.

Doc from javax.xml.stream.XMLStreamWriter.writeAttribute.

Writes an attribute to the output stream without a prefix.

Parameters
local:String

the local name of the attribute

value:String

the value of the attribute

Exceptions
XMLStreamException:
if an error occurs
writeCharactersback to summary
public void writeCharacters(String text) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeCharacters.

Doc from javax.xml.stream.XMLStreamWriter.writeCharacters.

Write text to the output

Parameters
text:String

the value to write

Exceptions
XMLStreamException:
if an error occurs
writeDefaultNamespaceback to summary
public void writeDefaultNamespace(String ns) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

Doc from javax.xml.stream.XMLStreamWriter.writeDefaultNamespace.

Writes the default namespace to the stream

Parameters
ns:String

the uri to bind the default namespace to

Exceptions
XMLStreamException:
if an error occurs
writeEndDocumentback to summary
public void writeEndDocument() throws XMLStreamException

Overrides org.codehaus.jettison.AbstractXMLStreamWriter.writeEndDocument.

Implements javax.xml.stream.XMLStreamWriter.writeEndDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeEndDocument.

Closes any start tags and writes corresponding end tags.

Exceptions
XMLStreamException:
if an error occurs
writeEndElementback to summary
public void writeEndElement() throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEndElement.

Doc from javax.xml.stream.XMLStreamWriter.writeEndElement.

Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.

Exceptions
XMLStreamException:
if an error occurs
writeEntityRefback to summary
public void writeEntityRef(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeEntityRef.

Doc from javax.xml.stream.XMLStreamWriter.writeEntityRef.

Writes an entity reference

Parameters
arg0:String

the name of the entity

Exceptions
XMLStreamException:
if an error occurs
writeNamespaceback to summary
public void writeNamespace(String prefix, String ns) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeNamespace.

Doc from javax.xml.stream.XMLStreamWriter.writeNamespace.

Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace

Parameters
prefix:String

the prefix to bind this namespace to

ns:String

the uri to bind the prefix to

Exceptions
XMLStreamException:
if an error occurs
writeProcessingInstructionback to summary
public void writeProcessingInstruction(String arg0, String arg1) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Doc from javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Writes a processing instruction

Parameters
arg0:String

the target of the processing instruction, may not be null

arg1:String

the data contained in the processing instruction, may not be null

Exceptions
XMLStreamException:
if an error occurs
writeProcessingInstructionback to summary
public void writeProcessingInstruction(String arg0) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Doc from javax.xml.stream.XMLStreamWriter.writeProcessingInstruction.

Writes a processing instruction

Parameters
arg0:String

the target of the processing instruction, may not be null

Exceptions
XMLStreamException:
if an error occurs
writeStartDocumentback to summary
public void writeStartDocument() throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartDocument.

Doc from javax.xml.stream.XMLStreamWriter.writeStartDocument.

Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8

Exceptions
XMLStreamException:
if an error occurs
writeStartElementback to summary
public void writeStartElement(String prefix, String local, String ns) throws XMLStreamException

Implements javax.xml.stream.XMLStreamWriter.writeStartElement.

Doc from javax.xml.stream.XMLStreamWriter.writeStartElement.

Writes a start tag to the output

Parameters
prefix:String

the prefix of the tag, may not be null

local:String

local name of the tag, may not be null

ns:String

the uri to bind the prefix to, may not be null

Exceptions
XMLStreamException:
if an error occurs