JavaEE API 8.0.1 · javax.xml.rpc.encoding.TypeMappingRegistry

Method Summary

Modifier and Type	Method and Description
public void	clear() Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.
public TypeMapping	Returns: TypeMapping instance createTypeMapping() Creates a new empty `TypeMapping` object.
public TypeMapping	Returns: The registered default `TypeMapping` instance or `null` getDefaultTypeMapping() Gets the registered default `TypeMapping` instance.
public String[]	Returns: Array of the registered encodingStyle URIs getRegisteredEncodingStyleURIs() Returns a list of registered encodingStyle URIs in this `TypeMappingRegistry` instance.
public TypeMapping	Returns: TypeMapping for the specified encodingStyleURI or `null` getTypeMapping(String Encoding style specified as an URI encodingStyleURI) Returns the registered `TypeMapping` for the specified encodingStyle URI.
public TypeMapping	Returns: Previous TypeMapping associated with the specified `encodingStyleURI`, or `null` if there was no TypeMapping associated with the specified `encodingStyleURI` register(String An encoding style specified as an URI. An example is "http://schemas.xmlsoap.org/soap/encoding/" encodingStyleURI, TypeMapping TypeMapping instance mapping) Registers a `TypeMapping` instance with the `TypeMappingRegistry`.
public void	registerDefault(TypeMapping TypeMapping instance mapping) Registers the `TypeMapping` instance that is default for all encoding styles supported by the `TypeMappingRegistry`.
public boolean	Returns: `true` if specified `TypeMapping` is removed from the TypeMappingRegistry; `false` if the specified `TypeMapping` was not in the `TypeMappingRegistry` removeTypeMapping(TypeMapping TypeMapping to be removed mapping) Removes a `TypeMapping` from the TypeMappingRegistry.
public TypeMapping	Returns: `TypeMapping` instance that has been unregistered or `null` if there was no TypeMapping registered for the specified `encodingStyleURI` unregisterTypeMapping(String Encoding style specified as an URI encodingStyleURI) Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI.

Method Detail

clear	back to summary
public void clear() Removes all registered TypeMappings and encodingStyleURIs from this TypeMappingRegistry.

createTypeMapping back to summary

createTypeMapping	back to summary
public TypeMapping createTypeMapping() Creates a new empty `TypeMapping` object. Returns:TypeMapping TypeMapping instance

public TypeMapping createTypeMapping()

Creates a new empty TypeMapping object.

Returns:TypeMapping: TypeMapping instance

getDefaultTypeMapping back to summary

getDefaultTypeMapping	back to summary
public TypeMapping getDefaultTypeMapping() Gets the registered default `TypeMapping` instance. This method returns `null` if there is no registered default TypeMapping in the registry. Returns:TypeMapping The registered default `TypeMapping` instance or `null`

public TypeMapping getDefaultTypeMapping()

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

Returns:TypeMapping: The registered default TypeMapping instance or null

getRegisteredEncodingStyleURIs back to summary

getRegisteredEncodingStyleURIs	back to summary
public String[] getRegisteredEncodingStyleURIs() Returns a list of registered encodingStyle URIs in this `TypeMappingRegistry` instance. Returns:String[] Array of the registered encodingStyle URIs

public String[] getRegisteredEncodingStyleURIs()

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

Returns:String[]: Array of the registered encodingStyle URIs

getTypeMapping back to summary

getTypeMapping	back to summary
public 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`. Parameters encodingStyleURI:String Encoding style specified as an URI Returns:TypeMapping TypeMapping for the specified encodingStyleURI or `null`

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

Parameters

encodingStyleURI:String: Encoding style specified as an URI

Returns:TypeMapping

TypeMapping for the specified encodingStyleURI or null

register	back to summary
public TypeMapping register(String encodingStyleURI, TypeMapping mapping) Registers a `TypeMapping` instance with the `TypeMappingRegistry`. This method replaces any existing registered `TypeMapping` instance for the specified `encodingStyleURI`. Parameters encodingStyleURI:String An encoding style specified as an URI. An example is "http://schemas.xmlsoap.org/soap/encoding/" mapping:TypeMapping TypeMapping instance Returns:TypeMapping Previous TypeMapping associated with the specified `encodingStyleURI`, or `null` if there was no TypeMapping associated with the specified `encodingStyleURI` Exceptions JAXRPCException: If there is an error in the registration of the `TypeMapping` for the specified `encodingStyleURI`.

public TypeMapping register(String encodingStyleURI, TypeMapping mapping)

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

Parameters

encodingStyleURI:String: An encoding style specified as an URI. An example is "http://schemas.xmlsoap.org/soap/encoding/"
mapping:TypeMapping: TypeMapping instance

Returns:TypeMapping

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

Exceptions

JAXRPCException:: If there is an error in the registration of the TypeMapping for the specified encodingStyleURI.

registerDefault back to summary

registerDefault	back to summary
public void registerDefault(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`. Parameters mapping:TypeMapping TypeMapping instance Exceptions JAXRPCException: If there is an error in the registration of the default `TypeMapping`

public void registerDefault(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.

Parameters

mapping:TypeMapping: TypeMapping instance

Exceptions

JAXRPCException:: If there is an error in the registration of the default TypeMapping

removeTypeMapping back to summary

removeTypeMapping	back to summary
public boolean removeTypeMapping(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. Parameters mapping:TypeMapping TypeMapping to be removed Returns:boolean `true` if specified `TypeMapping` is removed from the TypeMappingRegistry; `false` if the specified `TypeMapping` was not in the `TypeMappingRegistry`

public boolean removeTypeMapping(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.

Parameters

mapping:TypeMapping: TypeMapping to be removed

Returns:boolean

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

unregisterTypeMapping back to summary

unregisterTypeMapping	back to summary
public TypeMapping unregisterTypeMapping(String encodingStyleURI) Unregisters a TypeMapping instance, if present, from the specified encodingStyleURI. Parameters encodingStyleURI:String Encoding style specified as an URI Returns:TypeMapping `TypeMapping` instance that has been unregistered or `null` if there was no TypeMapping registered for the specified `encodingStyleURI`

public TypeMapping unregisterTypeMapping(String encodingStyleURI)

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

Parameters

encodingStyleURI:String: Encoding style specified as an URI

Returns:TypeMapping

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

public Interface TypeMappingRegistry

Method Summary

Method Detail