org.jboss.ws.core.jaxrpc

Class TypeMappingRegistryImpl

java.lang.Object

org.jboss.ws.core.jaxrpc.TypeMappingRegistryImpl

All Implemented Interfaces:

Serializable, javax.xml.rpc.encoding.TypeMappingRegistry

public class TypeMappingRegistryImpl
extends Object
implements javax.xml.rpc.encoding.TypeMappingRegistry

This defines a registry of TypeMapping instances for encoding styles.

Since:

04-Dec-2004

Author:

Thomas.Diesler@jboss.org

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TypeMappingRegistryImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.
javax.xml.rpc.encoding.TypeMapping	createTypeMapping() Creates a new empty TypeMapping object.
javax.xml.rpc.encoding.TypeMapping	getDefaultTypeMapping() Gets the registered default TypeMapping instance.
String[]	getRegisteredEncodingStyleURIs() Returns a list of registered encodingStyle URIs in this TypeMappingRegistry instance.
javax.xml.rpc.encoding.TypeMapping	getTypeMapping(String encodingStyleURI) Returns the registered TypeMapping for the specified encodingStyle URI.
javax.xml.rpc.encoding.TypeMapping	register(String encodingStyleURI, javax.xml.rpc.encoding.TypeMapping mapping) Registers a TypeMapping instance with the TypeMappingRegistry.
void	registerDefault(javax.xml.rpc.encoding.TypeMapping mapping) Registers the TypeMapping instance that is default for all encoding styles supported by the TypeMappingRegistry.
boolean	removeTypeMapping(javax.xml.rpc.encoding.TypeMapping mapping) Removes a TypeMapping from the TypeMappingRegistry.
javax.xml.rpc.encoding.TypeMapping	unregisterTypeMapping(String encodingStyleURI) Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TypeMappingRegistryImpl

public TypeMappingRegistryImpl()

Method Detail

clear

public void clear()

Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.

Specified by:

clear in interface javax.xml.rpc.encoding.TypeMappingRegistry

getDefaultTypeMapping

public javax.xml.rpc.encoding.TypeMapping getDefaultTypeMapping()

Gets the registered default TypeMapping instance. This method returns null if there is no registered default TypeMapping in the registry.

Specified by:

getDefaultTypeMapping in interface javax.xml.rpc.encoding.TypeMappingRegistry

Returns:

The registered default TypeMapping instance or null

registerDefault

public void registerDefault(javax.xml.rpc.encoding.TypeMapping mapping)

Registers the TypeMapping instance that is default for all encoding styles supported by the TypeMappingRegistry. A default TypeMapping should include serializers and deserializers that are independent of and usable with any encoding style. Successive invocations of the registerDefault method replace any existing default TypeMapping instance. If the default TypeMapping is registered, any other TypeMapping instances registered through the TypeMappingRegistry.register method (for a set of encodingStyle URIs) override the default TypeMapping.

Specified by:

registerDefault in interface javax.xml.rpc.encoding.TypeMappingRegistry

Parameters:

mapping - TypeMapping instance

Throws:

javax.xml.rpc.JAXRPCException - If there is an error in the registration of the default TypeMapping

createTypeMapping

public javax.xml.rpc.encoding.TypeMapping createTypeMapping()

Creates a new empty TypeMapping object.

Specified by:

createTypeMapping in interface javax.xml.rpc.encoding.TypeMappingRegistry

Returns:

TypeMapping instance

getTypeMapping

public javax.xml.rpc.encoding.TypeMapping getTypeMapping(String encodingStyleURI)

Returns the registered TypeMapping for the specified encodingStyle URI. If there is no registered TypeMapping for the specified encodingStyleURI, this method returns null.

Specified by:

getTypeMapping in interface javax.xml.rpc.encoding.TypeMappingRegistry

Parameters:

encodingStyleURI - Encoding style specified as an URI

Returns:

TypeMapping for the specified encodingStyleURI or null

getRegisteredEncodingStyleURIs

public String[] getRegisteredEncodingStyleURIs()

Returns a list of registered encodingStyle URIs in this TypeMappingRegistry instance.

Specified by:

getRegisteredEncodingStyleURIs in interface javax.xml.rpc.encoding.TypeMappingRegistry

Returns:

Array of the registered encodingStyle URIs

register

public javax.xml.rpc.encoding.TypeMapping register(String encodingStyleURI,
                                          javax.xml.rpc.encoding.TypeMapping mapping)

Registers a TypeMapping instance with the TypeMappingRegistry. This method replaces any existing registered TypeMapping instance for the specified encodingStyleURI.

Specified by:

register in interface javax.xml.rpc.encoding.TypeMappingRegistry

Parameters:

encodingStyleURI - An encoding style specified as an URI.

mapping - TypeMapping instance

Returns:

Previous TypeMapping associated with the specified encodingStyleURI, or null if there was no TypeMapping associated with the specified encodingStyleURI

Throws:

javax.xml.rpc.JAXRPCException - If there is an error in the registration of the TypeMapping for the specified encodingStyleURI.

unregisterTypeMapping

public javax.xml.rpc.encoding.TypeMapping unregisterTypeMapping(String encodingStyleURI)

Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.

Specified by:

unregisterTypeMapping in interface javax.xml.rpc.encoding.TypeMappingRegistry

Parameters:

encodingStyleURI - Encoding style specified as an URI

Returns:

TypeMapping instance that has been unregistered or null if there was no TypeMapping registered for the specified encodingStyleURI

removeTypeMapping

public boolean removeTypeMapping(javax.xml.rpc.encoding.TypeMapping mapping)

Removes a TypeMapping from the TypeMappingRegistry. A TypeMapping is associated with 1 or more encodingStyleURIs. This method unregisters the specified TypeMapping instance from all associated encodingStyleURIs and then removes this TypeMapping instance from the registry.

Specified by:

removeTypeMapping in interface javax.xml.rpc.encoding.TypeMappingRegistry

Parameters:

mapping - TypeMapping to be removed

Returns:

true if specified TypeMapping is removed from the TypeMappingRegistry; false if the specified TypeMapping was not in the TypeMappingRegistry