Serializer


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 org.jboss.axis.wsdl.fromJava.Types;
60  import org.w3c.dom.Element  ;
61  import org.xml.sax.Attributes  ;
62  
63  import javax.xml.namespace.QName  ;
64  import java.io.IOException  ;
65  
66  /**
67   * This interface describes the AXIS Serializer.
68   * An Axis compliant Serializer must provide one or more
69   * of the following methods:
70   * <p/>
71   * public <constructor>(Class javaType, QName xmlType)
72   * public <constructor>()
73   * <p/>
74   * This will allow for construction of generic factories that introspect the class
75   * to determine how to construct a deserializer.
76   * The xmlType, javaType arguments are filled in with the values known by the factory.
77   */
78  public interface Serializer extends javax.xml.rpc.encoding.Serializer  
79  {
80     /**
81      * Serialize an element named name, with the indicated attributes
82      * and value.
83      *
84      * @param name       is the element name
85      * @param attributes are the attributes...serialize is free to add more.
86      * @param value      is the value
87      * @param context    is the SerializationContext
88      */
89     public void serialize(QName   name, Attributes   attributes,
90                           Object   value, SerializationContext context)
91             throws IOException  ;
92  
93     /**
94      * Return XML schema for the specified type, suitable for insertion into
95      * the &lt;types&gt; element of a WSDL document, or underneath an
96      * &lt;element&gt; or &lt;attribute&gt; declaration.
97      *
98      * @param javaType the Java Class we're writing out schema for
99      * @param types    the Java2WSDL Types object which holds the context
100     *                 for the WSDL being generated.
101     * @return a type element containing a schema simpleType/complexType
102     * @see org.jboss.axis.wsdl.fromJava.Types
103     */
104    public Element   writeSchema(Class   javaType, Types types) throws Exception  ;
105 }
106 
107 
108
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags