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

TypeMappingRegistry

public interface TypeMappingRegistry implements Serializable
The interface javax.xml.rpc.encoding.TypeMappingRegistry defines a registry of TypeMapping instances for various encoding styles.
version
1.0

Fields Summary
Constructors Summary
Methods Summary
public voidclear()
Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.

public TypeMappingcreateTypeMapping()
Creates a new empty TypeMapping object.

return
TypeMapping instance.

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

return
The registered default TypeMapping instance or null

public java.lang.String[]getRegisteredEncodingStyleURIs()
Returns a list of registered encodingStyle URIs in this TypeMappingRegistry instance.

return
Array of the registered encodingStyle URIs

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

param
encodingStyleURI Encoding style specified as an URI
return
TypeMapping for the specified encodingStyleURI or null

public TypeMappingregister(java.lang.String encodingStyleURI, TypeMapping mapping)
Registers a TypeMapping instance with the TypeMappingRegistry. This method replaces any existing registered TypeMapping instance for the specified encodingStyleURI.

param
encodingStyleURI An encoding style specified as an URI. An example is "http://schemas.xmlsoap.org/soap/encoding/"
param
mapping TypeMapping instance
return
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 any error that prevents the registration of the TypeMapping for the specified encodingStyleURI

public voidregisterDefault(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.

param
mapping TypeMapping instance
throws
javax.xml.rpc.JAXRPCException if there is any error that prevents the registration of the default TypeMapping

public booleanremoveTypeMapping(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.

param
mapping TypeMapping to remove
return
true if specified TypeMapping is removed from the TypeMappingRegistry; false if the specified TypeMapping was not in the TypeMappingRegistry

public TypeMappingunregisterTypeMapping(java.lang.String encodingStyleURI)
Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.

param
encodingStyleURI Encoding style specified as an URI
return
TypeMapping instance that has been unregistered or null if there was no TypeMapping registered for the specified encodingStyleURI