|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.codehaus.jackson.JsonGenerator
org.codehaus.jackson.impl.JsonGeneratorBase
com.fasterxml.jackson.xml.ser.ToXmlGenerator
public final class ToXmlGenerator
JsonGenerator that outputs JAXB-style XML output instead of JSON content.
Operation requires calling code (usually either standard Jackson serializers,
or in some cases (like BeanSerializer) customised ones) to do
additional configuration calls beyond regular JsonGenerator API,
mostly to pass namespace information.
| Nested Class Summary | |
|---|---|
static class |
ToXmlGenerator.Feature
Enumeration that defines all togglable extra XML-specific features |
| Field Summary | |
|---|---|
protected LinkedList<QName> |
_elementNameStack
To support proper serialization of arrays it is necessary to keep stack of element names, so that we can "revert" to earlier |
protected org.codehaus.jackson.io.IOContext |
_ioContext
|
protected boolean |
_nextIsAttribute
Marker flag that indicates whether next name to write implies an attribute (true) or element (false) |
protected QName |
_nextName
Element or attribute name to use for next output call. |
protected int |
_xmlFeatures
Bit flag composed of bits that indicate which ToXmlGenerator.Features
are enabled. |
protected org.codehaus.stax2.XMLStreamWriter2 |
_xmlWriter
|
protected static String |
DEFAULT_UNKNOWN_ELEMENT
If we support optional definition of element names, this is the element name to use... |
| Fields inherited from class org.codehaus.jackson.impl.JsonGeneratorBase |
|---|
_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext |
| Fields inherited from class org.codehaus.jackson.JsonGenerator |
|---|
_cfgPrettyPrinter |
| Constructor Summary | |
|---|---|
ToXmlGenerator(org.codehaus.jackson.io.IOContext ctxt,
int genericGeneratorFeatures,
int xmlFeatures,
org.codehaus.jackson.ObjectCodec codec,
XMLStreamWriter sw)
|
|
| Method Summary | |
|---|---|
void |
_handleEndObject()
|
void |
_handleStartObject()
|
protected void |
_releaseBuffers()
|
protected void |
_verifyValueWrite(String typeMsg)
|
void |
close()
|
ToXmlGenerator |
configure(ToXmlGenerator.Feature f,
boolean state)
|
ToXmlGenerator |
disable(ToXmlGenerator.Feature f)
|
ToXmlGenerator |
enable(ToXmlGenerator.Feature f)
|
void |
finishWrappedValue(QName wrapperName,
QName wrappedName)
Method called after a structured collection output has completed |
void |
flush()
|
XMLStreamWriter |
getStaxWriter()
Method that allows application direct access to underlying Stax XMLStreamWriter. |
protected void |
handleMissingName()
|
void |
initGenerator()
Method called before writing any other output, to optionally output XML declaration. |
boolean |
isEnabled(ToXmlGenerator.Feature f)
|
void |
setNextIsAttribute(boolean isAttribute)
|
void |
setNextName(QName name)
|
void |
startWrappedValue(QName wrapperName,
QName wrappedName)
Methdod called when a structured (collection, array, map) is being output. |
org.codehaus.jackson.JsonGenerator |
useDefaultPrettyPrinter()
Standard JSON indenter does not work well with XML, use default XML indenter instead. |
void |
writeBinary(org.codehaus.jackson.Base64Variant b64variant,
byte[] data,
int offset,
int len)
|
void |
writeBoolean(boolean state)
|
void |
writeEndArray()
|
void |
writeEndObject()
|
void |
writeFieldName(org.codehaus.jackson.SerializableString name)
|
void |
writeFieldName(org.codehaus.jackson.io.SerializedString name)
|
void |
writeFieldName(String name)
|
void |
writeNull()
|
void |
writeNumber(BigDecimal dec)
|
void |
writeNumber(BigInteger v)
|
void |
writeNumber(double d)
|
void |
writeNumber(float f)
|
void |
writeNumber(int i)
|
void |
writeNumber(long l)
|
void |
writeNumber(String encodedValue)
|
void |
writeRaw(char c)
|
void |
writeRaw(char[] text,
int offset,
int len)
|
void |
writeRaw(String text)
|
void |
writeRaw(String text,
int offset,
int len)
|
void |
writeRawUTF8String(byte[] text,
int offset,
int length)
|
void |
writeStartArray()
|
void |
writeStartObject()
|
void |
writeString(char[] text,
int offset,
int len)
|
void |
writeString(org.codehaus.jackson.SerializableString text)
|
void |
writeString(String text)
|
void |
writeStringField(String fieldName,
String value)
|
void |
writeUTF8String(byte[] text,
int offset,
int length)
|
| Methods inherited from class org.codehaus.jackson.impl.JsonGeneratorBase |
|---|
_cantHappen, _reportError, _reportUnsupportedOperation, _throwInternal, _writeEndArray, _writeEndObject, _writeSimpleObject, _writeStartArray, _writeStartObject, copyCurrentEvent, copyCurrentStructure, disable, enable, getCodec, getOutputContext, isClosed, isEnabled, setCodec, version, writeObject, writeRawValue, writeRawValue, writeRawValue, writeTree |
| Methods inherited from class org.codehaus.jackson.JsonGenerator |
|---|
canUseSchema, configure, disableFeature, enableFeature, getCharacterEscapes, getHighestEscapedChar, getOutputTarget, isFeatureEnabled, setCharacterEscapes, setFeature, setHighestNonEscapedChar, setPrettyPrinter, setSchema, writeArrayFieldStart, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected static final String DEFAULT_UNKNOWN_ELEMENT
protected final org.codehaus.stax2.XMLStreamWriter2 _xmlWriter
protected final org.codehaus.jackson.io.IOContext _ioContext
protected int _xmlFeatures
ToXmlGenerator.Features
are enabled.
protected QName _nextName
protected boolean _nextIsAttribute
protected LinkedList<QName> _elementNameStack
| Constructor Detail |
|---|
public ToXmlGenerator(org.codehaus.jackson.io.IOContext ctxt,
int genericGeneratorFeatures,
int xmlFeatures,
org.codehaus.jackson.ObjectCodec codec,
XMLStreamWriter sw)
| Method Detail |
|---|
public void initGenerator()
throws IOException,
org.codehaus.jackson.JsonGenerationException
IOException
org.codehaus.jackson.JsonGenerationExceptionpublic ToXmlGenerator enable(ToXmlGenerator.Feature f)
public ToXmlGenerator disable(ToXmlGenerator.Feature f)
public final boolean isEnabled(ToXmlGenerator.Feature f)
public ToXmlGenerator configure(ToXmlGenerator.Feature f,
boolean state)
public XMLStreamWriter getStaxWriter()
XMLStreamWriter. Note that use of writer is
discouraged, and may interfere with processing of this writer;
however, occasionally it may be necessary.
Note: writer instance will always be of type
XMLStreamWriter2 (including
Typed Access API) so upcasts are safe.
public void setNextIsAttribute(boolean isAttribute)
public final void setNextName(QName name)
public void startWrappedValue(QName wrapperName,
QName wrappedName)
throws IOException,
org.codehaus.jackson.JsonGenerationException
wrapperName - Element used as wrapper around elements, if any (null if none)wrappedName - Element used around individual content items (can not
be null)
IOException
org.codehaus.jackson.JsonGenerationException
public void finishWrappedValue(QName wrapperName,
QName wrappedName)
throws IOException,
org.codehaus.jackson.JsonGenerationException
IOException
org.codehaus.jackson.JsonGenerationException
public final void writeFieldName(String name)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeFieldName in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public final void writeStringField(String fieldName,
String value)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeStringField in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public final void writeStartArray()
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeStartArray in class org.codehaus.jackson.impl.JsonGeneratorBaseIOException
org.codehaus.jackson.JsonGenerationException
public final void writeEndArray()
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeEndArray in class org.codehaus.jackson.impl.JsonGeneratorBaseIOException
org.codehaus.jackson.JsonGenerationException
public final void writeStartObject()
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeStartObject in class org.codehaus.jackson.impl.JsonGeneratorBaseIOException
org.codehaus.jackson.JsonGenerationException
public final void writeEndObject()
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeEndObject in class org.codehaus.jackson.impl.JsonGeneratorBaseIOException
org.codehaus.jackson.JsonGenerationException
public final void _handleStartObject()
throws IOException,
org.codehaus.jackson.JsonGenerationException
IOException
org.codehaus.jackson.JsonGenerationException
public final void _handleEndObject()
throws IOException,
org.codehaus.jackson.JsonGenerationException
IOException
org.codehaus.jackson.JsonGenerationException
public void writeFieldName(org.codehaus.jackson.io.SerializedString name)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeFieldName in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeFieldName(org.codehaus.jackson.SerializableString name)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeFieldName in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeString(String text)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeString in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeString(char[] text,
int offset,
int len)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeString in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeString(org.codehaus.jackson.SerializableString text)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeString in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeRawUTF8String(byte[] text,
int offset,
int length)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeRawUTF8String in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeUTF8String(byte[] text,
int offset,
int length)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeUTF8String in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeRaw(String text)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeRaw in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeRaw(String text,
int offset,
int len)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeRaw in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeRaw(char[] text,
int offset,
int len)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeRaw in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeRaw(char c)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeRaw in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeBinary(org.codehaus.jackson.Base64Variant b64variant,
byte[] data,
int offset,
int len)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeBinary in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeBoolean(boolean state)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeBoolean in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeNull()
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeNull in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeNumber(int i)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeNumber in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeNumber(long l)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeNumber in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeNumber(double d)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeNumber in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeNumber(float f)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeNumber in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeNumber(BigDecimal dec)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeNumber in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeNumber(BigInteger v)
throws IOException,
org.codehaus.jackson.JsonGenerationException
writeNumber in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
public void writeNumber(String encodedValue)
throws IOException,
org.codehaus.jackson.JsonGenerationException,
UnsupportedOperationException
writeNumber in class org.codehaus.jackson.JsonGeneratorIOException
org.codehaus.jackson.JsonGenerationException
UnsupportedOperationException
protected final void _verifyValueWrite(String typeMsg)
throws IOException,
org.codehaus.jackson.JsonGenerationException
_verifyValueWrite in class org.codehaus.jackson.impl.JsonGeneratorBaseIOException
org.codehaus.jackson.JsonGenerationExceptionpublic final org.codehaus.jackson.JsonGenerator useDefaultPrettyPrinter()
useDefaultPrettyPrinter in class org.codehaus.jackson.impl.JsonGeneratorBase
public final void flush()
throws IOException
flush in class org.codehaus.jackson.impl.JsonGeneratorBaseIOException
public void close()
throws IOException
close in interface Closeableclose in class org.codehaus.jackson.impl.JsonGeneratorBaseIOExceptionprotected void _releaseBuffers()
_releaseBuffers in class org.codehaus.jackson.impl.JsonGeneratorBaseprotected void handleMissingName()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||