KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > encoding > TypeMapping


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55
56
57 package org.jboss.axis.encoding;
58
59 import javax.xml.namespace.QName JavaDoc;
60 import javax.xml.rpc.JAXRPCException JavaDoc;
61 import javax.xml.rpc.encoding.DeserializerFactory JavaDoc;
62 import javax.xml.rpc.encoding.SerializerFactory JavaDoc;
63
64
65 /**
66  * This interface describes the AXIS TypeMapping.
67  */
68 public interface TypeMapping
69         extends javax.xml.rpc.encoding.TypeMapping JavaDoc
70 {
71
72    /**
73     * setDelegate sets the new Delegate TypeMapping
74     */
75    public void setDelegate(TypeMapping delegate);
76
77    /**
78     * getDelegate gets the new Delegate TypeMapping
79     */
80    public TypeMapping getDelegate();
81
82    /**
83     * Gets the SerializerFactory registered for the specified pair
84     * of Java type and XML data type.
85     *
86     * @param javaType - Class of the Java type
87     * @return Registered SerializerFactory
88     * @throws JAXRPCException - If there is no registered SerializerFactory
89     * for this pair of Java type and XML data type
90     * java.lang.IllegalArgumentException
91     * If invalid or unsupported XML/Java type is specified
92     */
93    public SerializerFactory getSerializer(Class JavaDoc javaType)
94            throws JAXRPCException JavaDoc;
95
96    /**
97     * Gets the DeserializerFactory registered for the specified XML data type.
98     *
99     * @param xmlType - Qualified name of the XML data type
100     * @return Registered DeserializerFactory
101     * @throws JAXRPCException - If there is no registered DeserializerFactory
102     * for this pair of Java type and XML data type
103     * java.lang.IllegalArgumentException -
104     * If invalid or unsupported XML/Java type is specified
105     */
106    public DeserializerFactory getDeserializer(QName JavaDoc xmlType)
107            throws JAXRPCException JavaDoc;
108
109    /**
110     * Gets the QName for the type mapped to Class.
111     *
112     * @param javaType class or type
113     * @return xmlType qname or null
114     */
115    public QName JavaDoc getTypeQName(Class JavaDoc javaType);
116
117    /**
118     * Gets the Class mapped to QName.
119     *
120     * @param xmlType qname or null
121     * @return javaType class or type
122     */
123    public Class JavaDoc getClassForQName(QName JavaDoc xmlType);
124
125    /**
126     * Returns an array of all the classes contained within this mapping
127     */
128    public Class JavaDoc[] getAllClasses();
129 }
130
131
132
Popular Tags