public class SerializationContext extends java.lang.Object implements SerializationContext
Modifier and Type | Field and Description |
---|---|
protected static org.apache.commons.logging.Log |
log |
protected boolean |
startOfDocument
The flag whether the XML decl should be written
|
Constructor and Description |
---|
SerializationContext(java.io.Writer writer)
Construct SerializationContext with associated writer
|
SerializationContext(java.io.Writer writer,
MessageContext msgContext)
Construct SerializationContext with associated writer and MessageContext
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
attributeQName2String(QName qName)
Convert attribute QName to a string of the form
|
void |
endElement()
Writes the end element tag for the open element.
|
Message |
getCurrentMessage()
Return the current message
|
QName |
getCurrentXMLType()
Get the currently prefered xmlType
|
boolean |
getDoMultiRefs()
Are we doing multirefs?
|
XMLEncoder |
getEncoder() |
java.lang.String |
getEncoding()
get the encoding for the serialization
|
java.lang.String |
getEncodingStyle()
Returns this context's encoding style.
|
QName |
getItemQName() |
QName |
getItemType() |
MessageContext |
getMessageContext()
Get the MessageContext we're operating with
|
java.lang.String |
getPrefixForURI(java.lang.String uri)
Get a prefix for a namespace URI.
|
java.lang.String |
getPrefixForURI(java.lang.String uri,
java.lang.String defaultPrefix)
Get a prefix for the given namespace URI.
|
java.lang.String |
getPrefixForURI(java.lang.String uri,
java.lang.String defaultPrefix,
boolean attribute)
Get a prefix for the given namespace URI.
|
boolean |
getPretty()
Get whether the serialization should be pretty printed.
|
QName |
getQNameForClass(java.lang.Class cls)
Get the QName associated with the specified class.
|
Serializer |
getSerializerForJavaType(java.lang.Class javaType)
Convenience method to get the Serializer for a specific
java type
|
TypeMapping |
getTypeMapping()
Get the TypeMapping we're using.
|
TypeMappingRegistry |
getTypeMappingRegistry()
Get the TypeMappingRegistry we're using.
|
java.lang.String |
getValueAsString(java.lang.Object value,
QName xmlType) |
boolean |
isEncoded()
Returns whether this context should be encoded or not.
|
boolean |
isPrimitive(java.lang.Object value)
Indicates whether the object should be interpretted as a primitive
for the purposes of multi-ref processing.
|
void |
outputMultiRefs()
The serialize method uses hrefs to reference all non-primitive
values.
|
java.lang.String |
qName2String(QName qName) |
java.lang.String |
qName2String(QName qName,
boolean writeNS)
Convert QName to a string of the form
|
void |
registerPrefixForURI(java.lang.String prefix,
java.lang.String uri)
Register prefix for the indicated uri
|
void |
serialize(QName elemQName,
org.xml.sax.Attributes attributes,
java.lang.Object value)
Serialize the indicated value as an element with the name
indicated by elemQName.
|
void |
serialize(QName elemQName,
org.xml.sax.Attributes attributes,
java.lang.Object value,
QName xmlType)
Serialize the indicated value as an element with the name
indicated by elemQName.
|
void |
serialize(QName elemQName,
org.xml.sax.Attributes attributes,
java.lang.Object value,
QName xmlType,
boolean sendNull,
java.lang.Boolean sendType)
Deprecated.
use serialize(QName, Attributes, Object, QName,
Boolean, Boolean) instead.
|
void |
serialize(QName elemQName,
org.xml.sax.Attributes attributes,
java.lang.Object value,
QName xmlType,
java.lang.Boolean sendNull,
java.lang.Boolean sendType)
Serialize the indicated value as an element with the name
indicated by elemQName.
|
void |
setDoMultiRefs(boolean shouldDo)
Set whether we are doing multirefs
|
void |
setEncoding(java.lang.String encoding)
set the encoding for the serialization
|
void |
setItemQName(QName itemQName) |
void |
setItemType(QName itemType) |
void |
setPretty(boolean pretty)
Indicate whether the serialization should be pretty printed.
|
void |
setSendDecl(boolean sendDecl)
Set whether or not we should write XML declarations.
|
org.xml.sax.Attributes |
setTypeAttribute(org.xml.sax.Attributes attributes,
QName type)
Obtains the type attribute that should be serialized and returns the new list of Attributes
|
void |
setWriteXMLType(QName type) |
boolean |
shouldSendXSIType()
Get whether or not to write xsi:type attributes.
|
void |
startElement(QName qName,
org.xml.sax.Attributes attributes)
Writes (using the Writer) the start tag for element QName along with the
indicated attributes and namespace mappings.
|
void |
writeChars(char[] p1,
int p2,
int p3)
Convenience operation to write out (to Writer) the characters
in p1 starting at index p2 for length p3.
|
void |
writeDOMElement(org.w3c.dom.Element el)
Output a DOM representation to a SerializationContext
|
void |
writeSafeString(java.lang.String string)
Convenience operation to write out (to Writer) the String
properly encoded with xml entities (like &)
|
void |
writeString(java.lang.String string)
Convenience operation to write out (to Writer) the String
|
void |
writeXMLDeclaration() |
protected static org.apache.commons.logging.Log log
protected boolean startOfDocument
public SerializationContext(java.io.Writer writer)
writer
- java.io.Writerpublic SerializationContext(java.io.Writer writer, MessageContext msgContext)
writer
- java.io.WritermsgContext
- is the MessageContextpublic boolean getPretty()
public void setPretty(boolean pretty)
pretty
- true/falsepublic boolean getDoMultiRefs()
public void setDoMultiRefs(boolean shouldDo)
public void setSendDecl(boolean sendDecl)
sendDecl
- true/falsepublic boolean shouldSendXSIType()
public TypeMapping getTypeMapping()
public TypeMappingRegistry getTypeMappingRegistry()
public java.lang.String getPrefixForURI(java.lang.String uri)
uri
- is the namespace uripublic java.lang.String getPrefixForURI(java.lang.String uri, java.lang.String defaultPrefix)
public java.lang.String getPrefixForURI(java.lang.String uri, java.lang.String defaultPrefix, boolean attribute)
public void registerPrefixForURI(java.lang.String prefix, java.lang.String uri)
prefix
- uri
- is the namespace uripublic Message getCurrentMessage()
public MessageContext getMessageContext()
public java.lang.String getEncodingStyle()
String
valuepublic boolean isEncoded()
boolean
valuepublic java.lang.String qName2String(QName qName, boolean writeNS)
qName
- public java.lang.String qName2String(QName qName)
public java.lang.String attributeQName2String(QName qName)
qName
- QNamepublic QName getQNameForClass(java.lang.Class cls)
cls
- Class of an object requiring serialization.public boolean isPrimitive(java.lang.Object value)
value
- to be serializedpublic void serialize(QName elemQName, org.xml.sax.Attributes attributes, java.lang.Object value) throws java.io.IOException
elemQName
- is the QName of the elementattributes
- are additional attributesvalue
- is the object to serializejava.io.IOException
public void serialize(QName elemQName, org.xml.sax.Attributes attributes, java.lang.Object value, QName xmlType) throws java.io.IOException
elemQName
- is the QName of the elementattributes
- are additional attributesvalue
- is the object to serializejava.io.IOException
public void serialize(QName elemQName, org.xml.sax.Attributes attributes, java.lang.Object value, QName xmlType, boolean sendNull, java.lang.Boolean sendType) throws java.io.IOException
elemQName
- is the QName of the elementattributes
- are additional attributesvalue
- is the object to serializexmlType
- is the qname of the type or null.sendNull
- determines whether to send null values.sendType
- determines whether to set xsi:type attribute.java.io.IOException
public void serialize(QName elemQName, org.xml.sax.Attributes attributes, java.lang.Object value, QName xmlType, java.lang.Boolean sendNull, java.lang.Boolean sendType) throws java.io.IOException
elemQName
- is the QName of the elementattributes
- are additional attributesvalue
- is the object to serializexmlType
- is the qname of the type or null.sendNull
- determines whether to send null values.sendType
- determines whether to set xsi:type attribute.java.io.IOException
public void outputMultiRefs() throws java.io.IOException
java.io.IOException
public void writeXMLDeclaration() throws java.io.IOException
java.io.IOException
public void startElement(QName qName, org.xml.sax.Attributes attributes) throws java.io.IOException
qName
- is the name of the elementattributes
- are the attributes to writejava.io.IOException
public void endElement() throws java.io.IOException
java.io.IOException
public void writeChars(char[] p1, int p2, int p3) throws java.io.IOException
p1
- character array to writep2
- starting index in arrayp3
- length to writejava.io.IOException
public void writeString(java.lang.String string) throws java.io.IOException
string
- is the String to write.java.io.IOException
public void writeSafeString(java.lang.String string) throws java.io.IOException
string
- is the String to write.java.io.IOException
public void writeDOMElement(org.w3c.dom.Element el) throws java.io.IOException
el
- is a DOM Elementjava.io.IOException
public final Serializer getSerializerForJavaType(java.lang.Class javaType)
javaType
- is Class for a type to serializepublic org.xml.sax.Attributes setTypeAttribute(org.xml.sax.Attributes attributes, QName type)
attributes
- of the qnametype
- is the qname of the typepublic QName getCurrentXMLType()
public java.lang.String getValueAsString(java.lang.Object value, QName xmlType) throws java.io.IOException
java.io.IOException
public void setWriteXMLType(QName type)
public XMLEncoder getEncoder()
public java.lang.String getEncoding()
public void setEncoding(java.lang.String encoding)
public QName getItemQName()
public void setItemQName(QName itemQName)
public QName getItemType()
public void setItemType(QName itemType)
Copyright ? 2005 Apache Web Services Project. All Rights Reserved.