javax.xml.rpc.encoding.TypeMappingRegistry Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2003-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.rpc.encoding;
import java.io.Serializable;
import javax.xml.rpc.JAXRPCException;
import java.util.Iterator;
/** The interface javax.xml.rpc.encoding.TypeMappingRegistry
* defines a registry of TypeMapping instances for various encoding
* styles.
*
* @version 1.0
* @author Rahul Sharma
**/
public interface TypeMappingRegistry extends Serializable {
/** 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 JAXRPCException If there is an error in the
* registration of the TypeMapping for
* the specified encodingStyleURI.
**/
public TypeMapping register(String encodingStyleURI, 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 JAXRPCException If there is an error in the
* registration of the default TypeMapping
**/
public void registerDefault(TypeMapping mapping);
/** 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 TypeMapping getDefaultTypeMapping();
/** Returns a list of registered encodingStyle URIs in this
* TypeMappingRegistry instance.
*
* @return Array of the registered encodingStyle URIs
**/
public String[] getRegisteredEncodingStyleURIs();
/** 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 TypeMapping getTypeMapping(String encodingStyleURI);
/** Creates a new empty TypeMapping object.
*
* @return TypeMapping instance
**/
public TypeMapping createTypeMapping();
/** 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
**/
public TypeMapping unregisterTypeMapping(String encodingStyleURI);
/** 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 be removed
* @return 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 all registered TypeMappings and encodingStyleURIs
* from this TypeMappingRegistry.
**/
public void clear();
}