javax.xml.rpc.encoding

Interface TypeMapping

public interface TypeMapping

This is the base interface for the representation of a type mapping. A TypeMapping implementation class may support one or more encoding styles. For its supported encoding styles, a TypeMapping instance maintains a set of tuples of the type {Java Class, SerializerFactory, DeserializerFactory, XML type-QName}.

Author:

Scott.Stark@jboss.org

Method Summary

Modifier and Type	Method and Description
DeserializerFactory	getDeserializer(Class javaType, QName xmlType) Gets the DeserializerFactory registered for the specified pair of Java type and XML data type.
SerializerFactory	getSerializer(Class javaType, QName xmlType) Gets the SerializerFactory registered for the specified pair of Java type and XML data type.
String[]	getSupportedEncodings() Returns the encodingStyle URIs (as String[]) supported by this TypeMapping instance.
boolean	isRegistered(Class javaType, QName xmlType) Checks whether or not type mapping between specified XML type and Java type is registered.
void	register(Class javaType, QName xmlType, SerializerFactory sf, DeserializerFactory dsf) Registers SerializerFactory and DeserializerFactory for a specific type mapping between an XML type and Java type.
void	removeDeserializer(Class javaType, QName xmlType) Removes the DeserializerFactory registered for the specified pair of Java type and XML data type.
void	removeSerializer(Class javaType, QName xmlType) Removes the SerializerFactory registered for the specified pair of Java type and XML data type.
void	setSupportedEncodings(String[] encodingStyleURIs) Sets the encodingStyle URIs supported by this TypeMapping instance.

Method Detail

getDeserializer

DeserializerFactory getDeserializer(Class javaType,
                                    QName xmlType)

Gets the DeserializerFactory registered for the specified pair of Java type and XML data type.

Parameters:

javaType - Class of the Java type

xmlType - QName of the XML type

Returns:

Registered DeserializerFactory or null if there is no registered factory

getSerializer

SerializerFactory getSerializer(Class javaType,
                                QName xmlType)

Gets the SerializerFactory registered for the specified pair of Java type and XML data type.

Parameters:

javaType - Class of the Java type

xmlType - QName of the XML type

Returns:

Registered SerializerFactory or null if there is no registered factory

getSupportedEncodings

String[] getSupportedEncodings()

Returns the encodingStyle URIs (as String[]) supported by this TypeMapping instance. A TypeMapping that contains only encoding style independent serializers and deserializers returns null from this method.

Returns:

Array of encodingStyle URIs for the supported encoding styles

setSupportedEncodings

void setSupportedEncodings(String[] encodingStyleURIs)

Sets the encodingStyle URIs supported by this TypeMapping instance. A TypeMapping that contains only encoding independent serializers and deserializers requires null as the parameter for this method.

Parameters:

encodingStyleURIs - Array of encodingStyle URIs for the supported encoding styles

isRegistered

boolean isRegistered(Class javaType,
                     QName xmlType)

Checks whether or not type mapping between specified XML type and Java type is registered.

Parameters:

javaType - Class of the Java type

xmlType - QName of the XML type

Returns:

boolean; true if type mapping between the specified XML type and Java type is registered; otherwise false

register

void register(Class javaType,
              QName xmlType,
              SerializerFactory sf,
              DeserializerFactory dsf)

Registers SerializerFactory and DeserializerFactory for a specific type mapping between an XML type and Java type. This method replaces any existing registered SerializerFactory DeserializerFactory instances.

Parameters:

javaType - Class of the Java type

xmlType - QName of the XML type

sf - SerializerFactory

dsf - DeserializerFactory

Throws:

JAXRPCException - If any error during the registration

removeDeserializer

void removeDeserializer(Class javaType,
                        QName xmlType)

Removes the DeserializerFactory registered for the specified pair of Java type and XML data type.

Parameters:

javaType - Class of the Java type

xmlType - QName of the XML type

Throws:

JAXRPCException - If there is error in removing the registered DeserializerFactory

removeSerializer

void removeSerializer(Class javaType,
                      QName xmlType)

Removes the SerializerFactory registered for the specified pair of Java type and XML data type.

Parameters:

javaType - Class of the Java type

xmlType - QName of the XML type

Throws:

JAXRPCException - If there is error in removing the registered SerializerFactory