Class NonNsStreamWriter

java.lang.Object

org.codehaus.stax2.ri.Stax2WriterImpl

com.ctc.wstx.sw.BaseStreamWriter

com.ctc.wstx.sw.TypedStreamWriter

com.ctc.wstx.sw.NonNsStreamWriter

All Implemented Interfaces:

OutputConfigFlags, XMLStreamConstants, XMLStreamWriter, org.codehaus.stax2.typed.TypedXMLStreamWriter, org.codehaus.stax2.validation.Validatable, org.codehaus.stax2.validation.ValidationContext, org.codehaus.stax2.XMLStreamWriter2

public class NonNsStreamWriter
extends TypedStreamWriter

Implementation of XMLStreamWriter used when namespace support is not enabled. This means that only local names are used for elements and attributes; and if rudimentary namespace declarations need to be output, they are output using attribute writing methods.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) TreeSet<String>	mAttrNames	Container for attribute names for current element; used only if uniqueness of attribute names is to be enforced.
(package private) final StringVector	mElements	Stack of currently open start elements; only local names are included.

Fields inherited from class TypedStreamWriter

mValueEncoderFactory

Fields inherited from class BaseStreamWriter

ATTR_MIN_ARRAYCOPY, CHAR_SPACE, DEFAULT_COPYBUFFER_LEN, mAnyOutput, mCfgAutomaticEmptyElems, mCfgCDataAsText, mCfgCopyDefaultAttrs, mCheckAttrs, mCheckStructure, mConfig, mCopyBuffer, mDtdRootElem, mEmptyElement, mEncoding, MIN_ARRAYCOPY, mReturnNullForDefaultNamespace, mStartElementOpen, mState, mValidator, mVldContent, mVldProbHandler, mWriter, mXml11, STATE_EPILOG, STATE_PROLOG, STATE_TREE

Fields inherited from interface OutputConfigFlags

CFG_ADD_SPACE_AFTER_EMPTY_ELEM, CFG_AUTO_CLOSE_OUTPUT, CFG_AUTOMATIC_EMPTY_ELEMENTS, CFG_AUTOMATIC_END_ELEMENTS, CFG_AUTOMATIC_NS, CFG_COPY_DEFAULT_ATTRS, CFG_ENABLE_NS, CFG_ESCAPE_CR, CFG_FIX_CONTENT, CFG_OUTPUT_CDATA_AS_TEXT, CFG_USE_DOUBLE_QUOTES_IN_XML_DECL, CFG_VALIDATE_ATTR, CFG_VALIDATE_CONTENT, CFG_VALIDATE_NAMES, CFG_VALIDATE_STRUCTURE

Fields inherited from interface XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors

Constructor	Description
NonNsStreamWriter(XmlWriter xw, String enc, WriterConfig cfg)

Method Summary

Modifier and Type	Method	Description
protected void	closeStartElement(boolean emptyElem)	Method called to close an open start element, when another main-level element (not namespace declaration or attribute) is being output; except for end element which is handled differently.
void	copyStartElement(InputElementStack elemStack, AttributeCollector attrCollector)	Element copier method implementation suitable to be used with non-namespace-aware writers.
private void	doWriteEndTag(String expName, boolean allowEmpty)	Note: Caller has to do actual removal of the element from element stack, before calling this method.
private void	doWriteStartElement(String localName)
QName	getCurrentElementName()
NamespaceContext	getNamespaceContext()
String	getNamespaceURI(String prefix)
String	getPrefix(String uri)
protected String	getTopElementDesc()	Method needed for error message generation
void	setDefaultNamespace(String uri)
void	setNamespaceContext(NamespaceContext context)
void	setPrefix(String prefix, String uri)
String	validateQNamePrefix(QName name)	Method called before writing a QName via Typed Access API.
void	writeAttribute(String localName, String value)
void	writeAttribute(String nsURI, String localName, String value)
void	writeAttribute(String prefix, String nsURI, String localName, String value)
void	writeDefaultNamespace(String nsURI)
void	writeEmptyElement(String localName)
void	writeEmptyElement(String nsURI, String localName)
void	writeEmptyElement(String prefix, String localName, String nsURI)
void	writeEndElement()
void	writeEndElement(QName name)	Method called by XMLEventWriter implementation (instead of the version that takes no argument), so that we can verify it does match the start element, if necessary
void	writeFullEndElement()	Similar to writeEndElement(), but never allows implicit creation of empty elements.
void	writeNamespace(String prefix, String nsURI)
void	writeStartElement(String localName)
void	writeStartElement(String nsURI, String localName)
void	writeStartElement(String prefix, String localName, String nsURI)
void	writeStartElement(StartElement elem)	Convenience method needed by XMLEventWriter implementation, to use when writing a start element, and possibly its attributes and namespace declarations.
protected void	writeTypedAttribute(String prefix, String nsURI, String localName, org.codehaus.stax2.ri.typed.AsciiValueEncoder enc)	Method that will write attribute with value that is known not to require additional escaping.

Methods inherited from class TypedStreamWriter

valueEncoderFactory, writeBinary, writeBinary, writeBinaryAttribute, writeBinaryAttribute, writeBoolean, writeBooleanAttribute, writeDecimal, writeDecimalAttribute, writeDouble, writeDoubleArray, writeDoubleArrayAttribute, writeDoubleAttribute, writeFloat, writeFloatArray, writeFloatArrayAttribute, writeFloatAttribute, writeInt, writeIntArray, writeIntArrayAttribute, writeIntAttribute, writeInteger, writeIntegerAttribute, writeLong, writeLongArray, writeLongArrayAttribute, writeLongAttribute, writeQName, writeQNameAttribute, writeTypedElement

Methods inherited from class BaseStreamWriter

addDefaultAttribute, close, closeCompletely, copyEventFromReader, doReportProblem, doReportProblem, doWriteStartDocument, findAttributeIndex, flush, getAttributeCount, getAttributeLocalName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getBaseUri, getCopyBuffer, getCopyBuffer, getEncoding, getLocation, getProperty, getValidationLocation, getXmlVersion, inPrologOrEpilog, isNotationDeclared, isPropertySupported, isUnparsedEntityDeclared, isValidating, reportIllegalArg, reportIllegalMethod, reportInvalidContent, reportNwfAttr, reportNwfAttr, reportNwfContent, reportNwfContent, reportNwfStructure, reportNwfStructure, reportProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, reportValidationProblem, setProperty, setValidationProblemHandler, stopValidatingAgainst, stopValidatingAgainst, throwFromIOE, throwOutputError, throwOutputError, toString, validateAgainst, verifyRootElement, verifyWriteCData, verifyWriteDTD, wrapAsRawWriter, wrapAsTextWriter, writeCData, writeCData, writeCharacters, writeCharacters, writeCharacters, writeComment, writeDTD, writeDTD, writeDTD, writeEndDocument, writeEntityRef, writeProcessingInstruction, writeProcessingInstruction, writeRaw, writeRaw, writeRaw, writeSpace, writeSpace, writeStartDocument, writeStartDocument, writeStartDocument, writeStartDocument

Methods inherited from class org.codehaus.stax2.ri.Stax2WriterImpl

copyStartElement

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

mElements

final StringVector mElements

Stack of currently open start elements; only local names are included.

mAttrNames

TreeSet<String> mAttrNames

Container for attribute names for current element; used only if uniqueness of attribute names is to be enforced.

TreeSet is used mostly because clearing it up is faster than clearing up HashSet, and the only access is done by adding entries and see if an value was already set.

Constructor Details

NonNsStreamWriter

public NonNsStreamWriter(XmlWriter xw,
 String enc,
 WriterConfig cfg)

Method Details

getNamespaceContext

public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface XMLStreamWriter

Specified by:

getNamespaceContext in class BaseStreamWriter

getPrefix

public String getPrefix(String uri)

Specified by:

getPrefix in interface XMLStreamWriter

Specified by:

getPrefix in class BaseStreamWriter

setDefaultNamespace

public void setDefaultNamespace(String uri)
                         throws XMLStreamException

Specified by:

setDefaultNamespace in interface XMLStreamWriter

Specified by:

setDefaultNamespace in class BaseStreamWriter

Throws:

XMLStreamException

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)

Specified by:

setNamespaceContext in interface XMLStreamWriter

Specified by:

setNamespaceContext in class BaseStreamWriter

setPrefix

public void setPrefix(String prefix,
 String uri)
               throws XMLStreamException

Specified by:

setPrefix in interface XMLStreamWriter

Specified by:

setPrefix in class BaseStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String localName,
 String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Specified by:

writeAttribute in class BaseStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String nsURI,
 String localName,
 String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Specified by:

writeAttribute in class BaseStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String prefix,
 String nsURI,
 String localName,
 String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Specified by:

writeAttribute in class BaseStreamWriter

Throws:

XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(String nsURI)
                           throws XMLStreamException

Specified by:

writeDefaultNamespace in interface XMLStreamWriter

Specified by:

writeDefaultNamespace in class BaseStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Specified by:

writeEmptyElement in class BaseStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String nsURI,
 String localName)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Specified by:

writeEmptyElement in class BaseStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String prefix,
 String localName,
 String nsURI)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Specified by:

writeEmptyElement in class BaseStreamWriter

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Specified by:

writeEndElement in interface XMLStreamWriter

Specified by:

writeEndElement in class BaseStreamWriter

Throws:

XMLStreamException

writeNamespace

public void writeNamespace(String prefix,
 String nsURI)
                    throws XMLStreamException

Specified by:

writeNamespace in interface XMLStreamWriter

Specified by:

writeNamespace in class BaseStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Specified by:

writeStartElement in class BaseStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String nsURI,
 String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Specified by:

writeStartElement in class BaseStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String prefix,
 String localName,
 String nsURI)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Specified by:

writeStartElement in class BaseStreamWriter

Throws:

XMLStreamException

writeFullEndElement

public void writeFullEndElement()
                         throws XMLStreamException

Similar to writeEndElement(), but never allows implicit creation of empty elements.

Specified by:

writeFullEndElement in interface org.codehaus.stax2.XMLStreamWriter2

Specified by:

writeFullEndElement in class BaseStreamWriter

Throws:

XMLStreamException

getCurrentElementName

public QName getCurrentElementName()

Specified by:

getCurrentElementName in interface org.codehaus.stax2.validation.ValidationContext

Specified by:

getCurrentElementName in class BaseStreamWriter

getNamespaceURI

public String getNamespaceURI(String prefix)

Specified by:

getNamespaceURI in interface org.codehaus.stax2.validation.ValidationContext

Specified by:

getNamespaceURI in class BaseStreamWriter

writeStartElement

public void writeStartElement(StartElement elem)
                       throws XMLStreamException

Description copied from class: BaseStreamWriter

Convenience method needed by XMLEventWriter implementation, to use when writing a start element, and possibly its attributes and namespace declarations.

Specified by:

writeStartElement in class BaseStreamWriter

Throws:

XMLStreamException

writeEndElement

public void writeEndElement(QName name)
                     throws XMLStreamException

Method called by XMLEventWriter implementation (instead of the version that takes no argument), so that we can verify it does match the start element, if necessary

Specified by:

writeEndElement in class BaseStreamWriter

Throws:

XMLStreamException

writeTypedAttribute

protected void writeTypedAttribute(String prefix,
 String nsURI,
 String localName,
 org.codehaus.stax2.ri.typed.AsciiValueEncoder enc)
                            throws XMLStreamException

Description copied from class: TypedStreamWriter

Method that will write attribute with value that is known not to require additional escaping.

Specified by:

writeTypedAttribute in class TypedStreamWriter

Throws:

XMLStreamException

closeStartElement

protected void closeStartElement(boolean emptyElem)
                          throws XMLStreamException

Method called to close an open start element, when another main-level element (not namespace declaration or attribute) is being output; except for end element which is handled differently.

Specified by:

closeStartElement in class BaseStreamWriter

Throws:

XMLStreamException

copyStartElement

public void copyStartElement(InputElementStack elemStack,
 AttributeCollector attrCollector)
                      throws IOException,
XMLStreamException

Element copier method implementation suitable to be used with non-namespace-aware writers. The only special thing here is that the copier can convert namespace declarations to equivalent attribute writes.

Specified by:

copyStartElement in class BaseStreamWriter

Throws:

IOException

XMLStreamException

getTopElementDesc

protected String getTopElementDesc()

Description copied from class: BaseStreamWriter

Method needed for error message generation

Specified by:

getTopElementDesc in class BaseStreamWriter

validateQNamePrefix

public String validateQNamePrefix(QName name)

Description copied from class: BaseStreamWriter

Method called before writing a QName via Typed Access API. In namespace-repairing mode it should take appropriate actions to ensure that the given namespace URI is bound to a namespace and return whatever it maps to. In non-repairing work no additional work is to be done and methods

Specified by:

validateQNamePrefix in class BaseStreamWriter

Returns:

Prefix to use when writing out given QName as an element or attribute value

doWriteStartElement

private void doWriteStartElement(String localName)
                          throws XMLStreamException

Throws:

XMLStreamException

doWriteEndTag

private void doWriteEndTag(String expName,
 boolean allowEmpty)
                    throws XMLStreamException

Note: Caller has to do actual removal of the element from element stack, before calling this method.

Parameters:

expName - Name that the closing element should have; null if whatever is in stack should be used

allowEmpty - If true, is allowed to create the empty element if the closing element was truly empty; if false, has to write the full empty element no matter what

Throws:

XMLStreamException