SerializationContext (JAXRPC API) - JBoss 3.2.7 jaxrpc API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.axis.encoding
Interface SerializationContext

All Superinterfaces:: javax.xml.rpc.encoding.SerializationContext

All Known Implementing Classes:: SerializationContextImpl

public interface SerializationContext
extends javax.xml.rpc.encoding.SerializationContext

This interface describes the AXIS SerializationContext.

Method Summary

String attributeQName2String(javax.xml.namespace.QName qName)
          Convert attribute QName to a string of the form : There are some special rules for attributes

void endDocument()
          Output anything in the end.

void endElement()
          Writes the end element tag for the open element.

Message getCurrentMessage()
          Get the current message.

javax.xml.namespace.QName getCurrentXMLType()
          Get the currently prefered xmlType `* @return QName of xmlType or null

boolean getDoMultiRefs()
          Are we doing multirefs?

Stack getElementStack()
          Get the stack of element qnames.

MessageContext getMessageContext()
          Get the MessageContext we're operating with

String getPrefixForURI(String uri)
          Get a prefix for a namespace URI.

String getPrefixForURI(String uri, String defaultPrefix)
          Get a prefix for a namespace URI.

boolean getPretty()
          Get whether the serialization should be pretty printed.

javax.xml.namespace.QName getQNameForClass(Class cls)
          Get the QName associated with the specified class.

Serializer getSerializerForJavaType(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.

String getValueAsString(Object value, javax.xml.namespace.QName xmlType)


boolean isNoDefaultNamespace()
          Get whether or not to write the default namespace.

boolean isPrimitive(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.

String qName2String(javax.xml.namespace.QName qName)
          Convert QName to a string of the form :

void registerPrefixForURI(String prefix, String uri)
          Register prefix for the indicated uri

void serialize(javax.xml.namespace.QName elemQName, Attributes attributes, Object value)
          Serialize the indicated value as an element with the name indicated by elemQName.

void serialize(javax.xml.namespace.QName elemQName, Attributes attributes, Object value, javax.xml.namespace.QName xmlType, boolean sendNull, 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 setNoDefaultNamespace(boolean noDefaultNamespace)
          Set whether or not to write the default namespace.

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.

Attributes setTypeAttribute(Attributes attributes, javax.xml.namespace.QName type)
          Obtains the type attribute that should be serialized and returns the new list of Attributes

boolean shouldSendXSIType()
          Get whether or not to write xsi:type attributes.

void startDocument()
          Output anything in the beginning.

void startElement(javax.xml.namespace.QName qName, 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(Element el)
          Output a DOM representation to a SerializationContext

void writeSafeString(String string)
          Convenience operation to write out (to Writer) the String properly encoded with xml entities (like &)

void writeString(String string)
          Convenience operation to write out (to Writer) the String

Method Detail

serialize

public void serialize(javax.xml.namespace.QName elemQName,
                      Attributes attributes,
                      Object value)
               throws IOException

Serialize the indicated value as an element with the name indicated by elemQName. The attributes are additional attribute to be serialized on the element. The value is the object being serialized. (It may be serialized directly or serialized as an mult-ref'd item) The value is an Object, which may be a wrapped primitive, the javaType is the actual unwrapped object type. The xmlType (if specified) is the QName of the type that is used to set xsi:type. If not specified, xsi:type is set by using the javaType to find an appopriate xmlType from the TypeMappingRegistry. The sendNull flag indicates whether null values should be sent over the wire (default is to send such values with xsi:nil="true"). The sendType flag indicates whether the xsi:type flag should be sent (default is true).

Parameters:: elemQName - is the QName of the element; attributes - are additional attributes; value - is the object to serialize
Throws:: IOException

serialize

public void serialize(javax.xml.namespace.QName elemQName,
                      Attributes attributes,
                      Object value,
                      javax.xml.namespace.QName xmlType,
                      boolean sendNull,
                      Boolean sendType)
               throws IOException

Serialize the indicated value as an element with the name indicated by elemQName. The attributes are additional attribute to be serialized on the element. The value is the object being serialized. (It may be serialized directly or serialized as an mult-ref'd item) The xmlType (if specified) is the QName of the type that is used to set xsi:type. The sendNull flag indicates whether null values should be sent over the wire (default is to send such values with xsi:nil="true"). The sendType flag indicates whether the xsi:type flag should be sent (default is true).

Parameters:: elemQName - is the QName of the element; attributes - are additional attributes; value - is the object to serialize; xmlType - is the qname of the type or null. (default is null); sendNull - determines whether to send null values. (default is true); sendType - determines whether to set xsi:type attribute. (default is true)
Throws:: IOException

setTypeAttribute

public Attributes setTypeAttribute(Attributes attributes,
                                   javax.xml.namespace.QName type)

Obtains the type attribute that should be serialized and returns the new list of Attributes

Parameters:: attributes - of the qname; type - is the qname of the type
Returns:: new list of Attributes

getSerializerForJavaType

public Serializer getSerializerForJavaType(Class javaType)

Convenience method to get the Serializer for a specific java type

Parameters:: javaType - is Class for a type to serialize
Returns:: Serializer

getPretty

public boolean getPretty()

Get whether the serialization should be pretty printed.

Returns:: true/false

setPretty

public void setPretty(boolean pretty)

Indicate whether the serialization should be pretty printed.

Parameters:: pretty - true/false

getDoMultiRefs

public boolean getDoMultiRefs()

Are we doing multirefs?

Returns:: true or false

setDoMultiRefs

public void setDoMultiRefs(boolean shouldDo)

Set whether we are doing multirefs.

Parameters:: shouldDo - true/false

setSendDecl

public void setSendDecl(boolean sendDecl)

Set whether or not we should write XML declarations.

Parameters:: sendDecl - true/false

shouldSendXSIType

public boolean shouldSendXSIType()

Get whether or not to write xsi:type attributes.

Returns:: true/false

getTypeMapping

public TypeMapping getTypeMapping()

Get the TypeMapping we're using.

Returns:: TypeMapping or null

getTypeMappingRegistry

public TypeMappingRegistry getTypeMappingRegistry()

Get the TypeMappingRegistry we're using.

Returns:: TypeMapping or null

getPrefixForURI

public String getPrefixForURI(String uri)

Get a prefix for a namespace URI. This method will ALWAYS return a valid prefix - if the given URI is already mapped in this serialization, we return the previous prefix. If it is not mapped, we will add a new mapping and return a generated prefix of the form "ns<num>".

Parameters:: uri - is the namespace uri
Returns:: prefix

getPrefixForURI

public String getPrefixForURI(String uri,
                              String defaultPrefix)

Parameters:: uri - is the namespace uri; defaultPrefix - optional parameter which is the default prefix
Returns:: prefix

registerPrefixForURI

public void registerPrefixForURI(String prefix,
                                 String uri)

Parameters:: prefix -; uri - is the namespace uri

getCurrentMessage

public Message getCurrentMessage()

Get the current message.

Returns:: Message

getMessageContext

public MessageContext getMessageContext()

Get the MessageContext we're operating with

qName2String

public String qName2String(javax.xml.namespace.QName qName)

Convert QName to a string of the form :

Parameters:: qName -
Returns:: prefixed qname representation for serialization.

attributeQName2String

public String attributeQName2String(javax.xml.namespace.QName qName)

Convert attribute QName to a string of the form : There are some special rules for attributes

Parameters:: qName -
Returns:: prefixed qname representation for serialization.

getQNameForClass

public javax.xml.namespace.QName getQNameForClass(Class cls)

Get the QName associated with the specified class.

Parameters:: cls - Class of an object requiring serialization.
Returns:: appropriate QName associated with the class.

isPrimitive

public boolean isPrimitive(Object value)

Indicates whether the object should be interpretted as a primitive for the purposes of multi-ref processing. A primitive value is serialized directly instead of using id/href pairs. Thus primitive serialization/deserialization is slightly faster.

Parameters:: value - to be serialized
Returns:: true/false

outputMultiRefs

public void outputMultiRefs()
                     throws IOException

The serialize method uses hrefs to reference all non-primitive values. These values are stored and serialized by calling outputMultiRefs after the serialize method completes.

Throws:: IOException

startDocument

public void startDocument()
                   throws IOException

Output anything in the beginning.

Throws:: IOException

endDocument

public void endDocument()
                 throws IOException

Output anything in the end.

Throws:: IOException

startElement

public void startElement(javax.xml.namespace.QName qName,
                         Attributes attributes)
                  throws IOException

Writes (using the Writer) the start tag for element QName along with the indicated attributes and namespace mappings.

Parameters:: qName - is the name of the element; attributes - are the attributes to write
Throws:: IOException

endElement

public void endElement()
                throws IOException

Writes the end element tag for the open element.

Throws:: IOException

writeChars

public void writeChars(char[] p1,
                       int p2,
                       int p3)
                throws IOException

Convenience operation to write out (to Writer) the characters in p1 starting at index p2 for length p3.

Parameters:: p1 - character array to write; p2 - starting index in array; p3 - length to write
Throws:: IOException

writeString

public void writeString(String string)
                 throws IOException

Convenience operation to write out (to Writer) the String

Parameters:: string - is the String to write.
Throws:: IOException

writeSafeString

public void writeSafeString(String string)
                     throws IOException

Convenience operation to write out (to Writer) the String properly encoded with xml entities (like &)

Parameters:: string - is the String to write.
Throws:: IOException

writeDOMElement

public void writeDOMElement(Element el)
                     throws IOException

Output a DOM representation to a SerializationContext

Parameters:: el - is a DOM Element
Throws:: IOException

getValueAsString

public String getValueAsString(Object value,
                               javax.xml.namespace.QName xmlType)
                        throws IOException

Throws:: IOException

getElementStack

public Stack getElementStack()

Get the stack of element qnames.

getCurrentXMLType

public javax.xml.namespace.QName getCurrentXMLType()

Get the currently prefered xmlType `* @return QName of xmlType or null

isNoDefaultNamespace

public boolean isNoDefaultNamespace()

Get whether or not to write the default namespace.

Returns:: true/false

setNoDefaultNamespace

public void setNoDefaultNamespace(boolean noDefaultNamespace)

Set whether or not to write the default namespace.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Method Summary
`String`	`attributeQName2String(javax.xml.namespace.QName qName)` Convert attribute QName to a string of the form : There are some special rules for attributes
`void`	`endDocument()` Output anything in the end.
`void`	`endElement()` Writes the end element tag for the open element.
`Message`	`getCurrentMessage()` Get the current message.
`javax.xml.namespace.QName`	`getCurrentXMLType()` Get the currently prefered xmlType `* @return QName of xmlType or null
`boolean`	`getDoMultiRefs()` Are we doing multirefs?
`Stack`	`getElementStack()` Get the stack of element qnames.
`MessageContext`	`getMessageContext()` Get the MessageContext we're operating with
`String`	`getPrefixForURI(String uri)` Get a prefix for a namespace URI.
`String`	`getPrefixForURI(String uri, String defaultPrefix)` Get a prefix for a namespace URI.
`boolean`	`getPretty()` Get whether the serialization should be pretty printed.
`javax.xml.namespace.QName`	`getQNameForClass(Class cls)` Get the QName associated with the specified class.
`Serializer`	`getSerializerForJavaType(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.
`String`	`getValueAsString(Object value, javax.xml.namespace.QName xmlType)`
`boolean`	`isNoDefaultNamespace()` Get whether or not to write the default namespace.
`boolean`	`isPrimitive(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.
`String`	`qName2String(javax.xml.namespace.QName qName)` Convert QName to a string of the form :
`void`	`registerPrefixForURI(String prefix, String uri)` Register prefix for the indicated uri
`void`	`serialize(javax.xml.namespace.QName elemQName, Attributes attributes, Object value)` Serialize the indicated value as an element with the name indicated by elemQName.
`void`	`serialize(javax.xml.namespace.QName elemQName, Attributes attributes, Object value, javax.xml.namespace.QName xmlType, boolean sendNull, 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`	`setNoDefaultNamespace(boolean noDefaultNamespace)` Set whether or not to write the default namespace.
`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.
`Attributes`	`setTypeAttribute(Attributes attributes, javax.xml.namespace.QName type)` Obtains the type attribute that should be serialized and returns the new list of Attributes
`boolean`	`shouldSendXSIType()` Get whether or not to write xsi:type attributes.
`void`	`startDocument()` Output anything in the beginning.
`void`	`startElement(javax.xml.namespace.QName qName, 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(Element el)` Output a DOM representation to a SerializationContext
`void`	`writeSafeString(String string)` Convenience operation to write out (to Writer) the String properly encoded with xml entities (like &)
`void`	`writeString(String string)` Convenience operation to write out (to Writer) the String

SerializationContext (JAXRPC API) - JBoss 3.2.7 jaxrpc API Documentation 英文版文档

org.apache.axis.encoding Interface SerializationContext

serialize

serialize

setTypeAttribute

getSerializerForJavaType

getPretty

setPretty

getDoMultiRefs

setDoMultiRefs

setSendDecl

shouldSendXSIType

getTypeMapping

getTypeMappingRegistry

getPrefixForURI

getPrefixForURI

registerPrefixForURI

getCurrentMessage

getMessageContext

qName2String

attributeQName2String

getQNameForClass

isPrimitive

outputMultiRefs

startDocument

endDocument

startElement

endElement

writeChars

writeString

writeSafeString

writeDOMElement

getValueAsString

getElementStack

getCurrentXMLType

isNoDefaultNamespace

setNoDefaultNamespace

org.apache.axis.encoding
Interface SerializationContext