Package javax.xml.rpc.encoding
Interface TypeMappingRegistry
-
- All Superinterfaces:
java.io.Serializable
public interface TypeMappingRegistry extends java.io.Serializable
The interfacejavax.xml.rpc.encoding.TypeMappingRegistry
defines a registry of TypeMapping instances for various encoding styles.- Version:
- 1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clear()
Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.TypeMapping
createTypeMapping()
Creates a new emptyTypeMapping
object.TypeMapping
getDefaultTypeMapping()
Gets the registered defaultTypeMapping
instance.java.lang.String[]
getRegisteredEncodingStyleURIs()
Returns a list of registered encodingStyle URIs in thisTypeMappingRegistry
instance.TypeMapping
getTypeMapping(java.lang.String encodingStyleURI)
Returns the registeredTypeMapping
for the specified encodingStyle URI.TypeMapping
register(java.lang.String encodingStyleURI, TypeMapping mapping)
Registers aTypeMapping
instance with theTypeMappingRegistry
.void
registerDefault(TypeMapping mapping)
Registers theTypeMapping
instance that is default for all encoding styles supported by theTypeMappingRegistry
.boolean
removeTypeMapping(TypeMapping mapping)
Removes aTypeMapping
from the TypeMappingRegistry.TypeMapping
unregisterTypeMapping(java.lang.String encodingStyleURI)
Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.
-
-
-
Method Detail
-
register
TypeMapping register(java.lang.String encodingStyleURI, TypeMapping mapping)
Registers aTypeMapping
instance with theTypeMappingRegistry
. This method replaces any existing registeredTypeMapping
instance for the specifiedencodingStyleURI
.- Parameters:
encodingStyleURI
- An encoding style specified as an URI. An example is "http://schemas.xmlsoap.org/soap/encoding/"mapping
- TypeMapping instance- Returns:
- Previous TypeMapping associated with the specified
encodingStyleURI
, ornull
if there was no TypeMapping associated with the specifiedencodingStyleURI
- Throws:
JAXRPCException
- If there is an error in the registration of theTypeMapping
for the specifiedencodingStyleURI
.
-
registerDefault
void registerDefault(TypeMapping mapping)
Registers theTypeMapping
instance that is default for all encoding styles supported by theTypeMappingRegistry
. A defaultTypeMapping
should include serializers and deserializers that are independent of and usable with any encoding style. Successive invocations of theregisterDefault
method replace any existing defaultTypeMapping
instance.If the default
TypeMapping
is registered, any other TypeMapping instances registered through theTypeMappingRegistry.register
method (for a set of encodingStyle URIs) override the defaultTypeMapping
.- Parameters:
mapping
- TypeMapping instance- Throws:
JAXRPCException
- If there is an error in the registration of the defaultTypeMapping
-
getDefaultTypeMapping
TypeMapping getDefaultTypeMapping()
Gets the registered defaultTypeMapping
instance. This method returnsnull
if there is no registered default TypeMapping in the registry.- Returns:
- The registered default
TypeMapping
instance ornull
-
getRegisteredEncodingStyleURIs
java.lang.String[] getRegisteredEncodingStyleURIs()
Returns a list of registered encodingStyle URIs in thisTypeMappingRegistry
instance.- Returns:
- Array of the registered encodingStyle URIs
-
getTypeMapping
TypeMapping getTypeMapping(java.lang.String encodingStyleURI)
Returns the registeredTypeMapping
for the specified encodingStyle URI. If there is no registeredTypeMapping
for the specifiedencodingStyleURI
, this method returnsnull
.- Parameters:
encodingStyleURI
- Encoding style specified as an URI- Returns:
- TypeMapping for the specified encodingStyleURI or
null
-
createTypeMapping
TypeMapping createTypeMapping()
Creates a new emptyTypeMapping
object.- Returns:
- TypeMapping instance
-
unregisterTypeMapping
TypeMapping unregisterTypeMapping(java.lang.String encodingStyleURI)
Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.- Parameters:
encodingStyleURI
- Encoding style specified as an URI- Returns:
TypeMapping
instance that has been unregistered ornull
if there was no TypeMapping registered for the specifiedencodingStyleURI
-
removeTypeMapping
boolean removeTypeMapping(TypeMapping mapping)
Removes aTypeMapping
from the TypeMappingRegistry. ATypeMapping
is associated with 1 or more encodingStyleURIs. This method unregisters the specifiedTypeMapping
instance from all associatedencodingStyleURIs
and then removes this TypeMapping instance from the registry.- Parameters:
mapping
- TypeMapping to be removed- Returns:
true
if specifiedTypeMapping
is removed from the TypeMappingRegistry;false
if the specifiedTypeMapping
was not in theTypeMappingRegistry
-
clear
void clear()
Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.
-
-