|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.codehaus.stax2.ri.Stax2WriterImpl
com.ctc.wstx.sw.BaseStreamWriter
com.ctc.wstx.sw.TypedStreamWriter
com.ctc.wstx.sw.BaseNsStreamWriter
public abstract class BaseNsStreamWriter
Mid-level base class of namespace-aware stream writers. Contains shared functionality between repairing and non-repairing implementations.
| Field Summary | |
|---|---|
protected static String |
ERR_NSDECL_WRONG_STATE
|
protected boolean |
mAutomaticNS
True, if writer needs to automatically output namespace declarations (we are in repairing mode) |
protected SimpleOutputElement |
mCurrElem
|
protected EmptyElementHandler |
mEmptyElementHandler
|
protected SimpleOutputElement |
mOutputElemPool
|
protected int |
mPoolSize
|
protected NamespaceContext |
mRootNsContext
Optional "root" namespace context that application can set. |
protected static String |
sPrefixXml
|
protected static String |
sPrefixXmlns
|
| Fields inherited from class com.ctc.wstx.sw.TypedStreamWriter |
|---|
mValueEncoderFactory |
| Fields inherited from class com.ctc.wstx.sw.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 com.ctc.wstx.cfg.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_VALIDATE_ATTR, CFG_VALIDATE_CONTENT, CFG_VALIDATE_NAMES, CFG_VALIDATE_STRUCTURE |
| Fields inherited from interface javax.xml.stream.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 | |
|---|---|
BaseNsStreamWriter(XmlWriter xw,
String enc,
WriterConfig cfg,
boolean repairing)
|
|
| Method Summary | |
|---|---|
protected void |
checkStartElement(String localName,
String prefix)
Method that is called to ensure that we can start writing an element, both from structural point of view, and from syntactic (close previously open start element, if any). |
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. |
abstract void |
doSetPrefix(String prefix,
String uri)
|
protected void |
doWriteAttr(String localName,
String nsURI,
String prefix,
char[] buf,
int start,
int len)
|
protected void |
doWriteAttr(String localName,
String nsURI,
String prefix,
String value)
|
protected void |
doWriteDefaultNs(String nsURI)
|
protected void |
doWriteEndTag(QName expName,
boolean allowEmpty)
|
protected void |
doWriteNamespace(String prefix,
String nsURI)
|
protected void |
doWriteStartTag(String localName)
|
protected void |
doWriteStartTag(String prefix,
String localName)
|
QName |
getCurrentElementName()
Method that can be used to access name information of the innermost (top) element in the element stack. |
NamespaceContext |
getNamespaceContext()
|
String |
getNamespaceURI(String prefix)
Method that can be called by the validator to resolve a namespace prefix of the currently active top-level element. |
String |
getPrefix(String uri)
|
protected String |
getTopElementDesc()
Method needed for error message generation |
abstract void |
setDefaultNamespace(String uri)
|
void |
setNamespaceContext(NamespaceContext ctxt)
Note: Root namespace context works best if automatic prefix creation ("namespace/prefix repairing" in StAX lingo) is enabled. |
void |
setPrefix(String prefix,
String uri)
|
void |
writeAttribute(String localName,
String value)
It's assumed calling this method implies caller just wants to add an attribute that does not belong to any namespace; as such no namespace checking or prefix generation is needed. |
abstract void |
writeAttribute(String nsURI,
String localName,
String value)
|
abstract void |
writeAttribute(String prefix,
String nsURI,
String localName,
String value)
|
abstract void |
writeDefaultNamespace(String nsURI)
|
void |
writeEmptyElement(String localName)
Note: It is assumed caller just wants the element to belong to whatever is the current default namespace. |
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. |
abstract void |
writeNamespace(String prefix,
String nsURI)
|
abstract void |
writeStartElement(StartElement elem)
Convenience method needed by XMLEventWriter
implementation, to use when
writing a start element, and possibly its attributes and namespace
declarations. |
void |
writeStartElement(String localName)
This method is assumed to just use default namespace (if any), and no further checks should be done. |
void |
writeStartElement(String nsURI,
String localName)
|
void |
writeStartElement(String prefix,
String localName,
String nsURI)
|
protected abstract void |
writeStartOrEmpty(String localName,
String nsURI)
|
protected abstract void |
writeStartOrEmpty(String prefix,
String localName,
String nsURI)
|
protected void |
writeTypedAttribute(String prefix,
String nsURI,
String localName,
AsciiValueEncoder enc)
Method that will write attribute with value that is known not to require additional escaping. |
| Methods inherited from class org.codehaus.stax2.ri.Stax2WriterImpl |
|---|
copyStartElement |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected static final String sPrefixXml
protected static final String sPrefixXmlns
protected static final String ERR_NSDECL_WRONG_STATE
protected final boolean mAutomaticNS
protected final EmptyElementHandler mEmptyElementHandler
protected SimpleOutputElement mCurrElem
protected NamespaceContext mRootNsContext
protected SimpleOutputElement mOutputElemPool
protected int mPoolSize
| Constructor Detail |
|---|
public BaseNsStreamWriter(XmlWriter xw,
String enc,
WriterConfig cfg,
boolean repairing)
| Method Detail |
|---|
public NamespaceContext getNamespaceContext()
getNamespaceContext in interface XMLStreamWritergetNamespaceContext in class BaseStreamWriterpublic String getPrefix(String uri)
getPrefix in interface XMLStreamWritergetPrefix in class BaseStreamWriter
public abstract void setDefaultNamespace(String uri)
throws XMLStreamException
setDefaultNamespace in interface XMLStreamWritersetDefaultNamespace in class BaseStreamWriterXMLStreamException
public void setNamespaceContext(NamespaceContext ctxt)
throws XMLStreamException
Note: Root namespace context works best if automatic prefix creation ("namespace/prefix repairing" in StAX lingo) is enabled.
setNamespaceContext in interface XMLStreamWritersetNamespaceContext in class BaseStreamWriterXMLStreamException
public void setPrefix(String prefix,
String uri)
throws XMLStreamException
setPrefix in interface XMLStreamWritersetPrefix in class BaseStreamWriterXMLStreamException
public void writeAttribute(String localName,
String value)
throws XMLStreamException
writeAttribute in interface XMLStreamWriterwriteAttribute in class BaseStreamWriterXMLStreamException
public abstract void writeAttribute(String nsURI,
String localName,
String value)
throws XMLStreamException
writeAttribute in interface XMLStreamWriterwriteAttribute in class BaseStreamWriterXMLStreamException
public abstract void writeAttribute(String prefix,
String nsURI,
String localName,
String value)
throws XMLStreamException
writeAttribute in interface XMLStreamWriterwriteAttribute in class BaseStreamWriterXMLStreamException
public void writeEmptyElement(String localName)
throws XMLStreamException
Note: It is assumed caller just wants the element to belong to whatever is the current default namespace.
writeEmptyElement in interface XMLStreamWriterwriteEmptyElement in class BaseStreamWriterXMLStreamException
public void writeEmptyElement(String nsURI,
String localName)
throws XMLStreamException
writeEmptyElement in interface XMLStreamWriterwriteEmptyElement in class BaseStreamWriterXMLStreamException
public void writeEmptyElement(String prefix,
String localName,
String nsURI)
throws XMLStreamException
writeEmptyElement in interface XMLStreamWriterwriteEmptyElement in class BaseStreamWriterXMLStreamException
public void writeEndElement()
throws XMLStreamException
writeEndElement in interface XMLStreamWriterwriteEndElement in class BaseStreamWriterXMLStreamException
public void writeStartElement(String localName)
throws XMLStreamException
writeStartElement in interface XMLStreamWriterwriteStartElement in class BaseStreamWriterXMLStreamException
public void writeStartElement(String nsURI,
String localName)
throws XMLStreamException
writeStartElement in interface XMLStreamWriterwriteStartElement in class BaseStreamWriterXMLStreamException
public void writeStartElement(String prefix,
String localName,
String nsURI)
throws XMLStreamException
writeStartElement in interface XMLStreamWriterwriteStartElement in class BaseStreamWriterXMLStreamException
protected void writeTypedAttribute(String prefix,
String nsURI,
String localName,
AsciiValueEncoder enc)
throws XMLStreamException
TypedStreamWriter
writeTypedAttribute in class TypedStreamWriterXMLStreamException
public void writeFullEndElement()
throws XMLStreamException
writeEndElement(), but never allows implicit
creation of empty elements.
writeFullEndElement in interface XMLStreamWriter2writeFullEndElement in class BaseStreamWriterXMLStreamExceptionpublic QName getCurrentElementName()
ValidationContext
getCurrentElementName in interface ValidationContextgetCurrentElementName in class BaseStreamWriterpublic String getNamespaceURI(String prefix)
ValidationContext
getNamespaceURI in interface ValidationContextgetNamespaceURI in class BaseStreamWriter
public void writeEndElement(QName name)
throws XMLStreamException
XMLEventWriter implementation
(instead of the version
that takes no argument), so that we can verify it does match the
start element, if necessary
writeEndElement in class BaseStreamWriterXMLStreamException
protected void closeStartElement(boolean emptyElem)
throws XMLStreamException
closeStartElement in class BaseStreamWriteremptyElem - If true, the element being closed is an empty
element; if false, a separate stand-alone start element.
XMLStreamExceptionprotected String getTopElementDesc()
BaseStreamWriter
getTopElementDesc in class BaseStreamWriter
protected void checkStartElement(String localName,
String prefix)
throws XMLStreamException
XMLStreamException
protected final void doWriteAttr(String localName,
String nsURI,
String prefix,
String value)
throws XMLStreamException
XMLStreamException
protected final void doWriteAttr(String localName,
String nsURI,
String prefix,
char[] buf,
int start,
int len)
throws XMLStreamException
XMLStreamException
protected void doWriteNamespace(String prefix,
String nsURI)
throws XMLStreamException
XMLStreamException
protected void doWriteDefaultNs(String nsURI)
throws XMLStreamException
XMLStreamException
protected final void doWriteStartTag(String localName)
throws XMLStreamException
XMLStreamException
protected final void doWriteStartTag(String prefix,
String localName)
throws XMLStreamException
XMLStreamException
protected void doWriteEndTag(QName expName,
boolean allowEmpty)
throws XMLStreamException
expName - Name that the closing element should have; null
if whatever is in stack should be usedallowEmpty - 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
XMLStreamException
public abstract void doSetPrefix(String prefix,
String uri)
throws XMLStreamException
XMLStreamException
public abstract void writeDefaultNamespace(String nsURI)
throws XMLStreamException
writeDefaultNamespace in interface XMLStreamWriterwriteDefaultNamespace in class BaseStreamWriterXMLStreamException
public abstract void writeNamespace(String prefix,
String nsURI)
throws XMLStreamException
writeNamespace in interface XMLStreamWriterwriteNamespace in class BaseStreamWriterXMLStreamException
public abstract void writeStartElement(StartElement elem)
throws XMLStreamException
BaseStreamWriterXMLEventWriter
implementation, to use when
writing a start element, and possibly its attributes and namespace
declarations.
writeStartElement in class BaseStreamWriterXMLStreamException
protected abstract void writeStartOrEmpty(String localName,
String nsURI)
throws XMLStreamException
XMLStreamException
protected abstract void writeStartOrEmpty(String prefix,
String localName,
String nsURI)
throws XMLStreamException
XMLStreamException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||