FileDocCategorySizeDatePackage
TypeMapping.javaAPI DocApache Axis 1.44914Sat Apr 22 18:57:28 BST 2006javax.xml.rpc.encoding

TypeMapping

public interface TypeMapping
The javax.xml.rpc.encoding.TypeMapping 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 type, SerializerFactory, DeserializerFactory, XML type}.

version
1.0

Fields Summary
Constructors Summary
Methods Summary
public DeserializerFactorygetDeserializer(java.lang.Class javaType, javax.xml.namespace.QName xmlType)
Gets the DeserializerFactory registered for the specified pair of Java type and XML data type.

param
javaType Class of the Java type
param
xmlType Qualified name of the XML data type
return
Registered SerializerFactory or null if there is no registered factory

public SerializerFactorygetSerializer(java.lang.Class javaType, javax.xml.namespace.QName xmlType)
Gets the SerializerFactory registered for the specified pair of Java type and XML data type.

param
javaType Class of the Java type
param
xmlType Qualified name of the XML data type
return
Registered SerializerFactory or null if there is no registered factory

public java.lang.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.

return
Array of encodingStyle URIs for the supported encoding styles

public booleanisRegistered(java.lang.Class javaType, javax.xml.namespace.QName xmlType)
Checks whether or not type mapping between specified XML type and Java type is registered.

param
javaType Class of the Java type
param
xmlType Qualified name of the XML data type
return
boolean; true if type mapping between the specified XML type and Java type is registered; otherwise false

public voidregister(java.lang.Class javaType, javax.xml.namespace.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.

param
javaType Class of the Java type
param
xmlType Qualified name of the XML data type
param
sf SerializerFactory
param
dsf DeserializerFactory
throws
javax.xml.rpc.JAXRPCException if there are any errors that prevent registration

public voidremoveDeserializer(java.lang.Class javaType, javax.xml.namespace.QName xmlType)
Removes the DeserializerFactory registered for the specified pair of Java type and XML data type.

param
javaType Class of the Java type
param
xmlType Qualified name of the XML data type
throws
javax.xml.rpc.JAXRPCException if there is any error in removing the registered DeserializerFactory

public voidremoveSerializer(java.lang.Class javaType, javax.xml.namespace.QName xmlType)
Removes the SerializerFactory registered for the specified pair of Java type and XML data type.

param
javaType Class of the Java type
param
xmlType Qualified name of the XML data type
throws
javax.xml.rpc.JAXRPCException if there is any error that prevents removal of the registered SerializerFactory

public voidsetSupportedEncodings(java.lang.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.

param
encodingStyleURIs Array of encodingStyle URIs for the supported encoding styles