KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > wsdl > toJava > JavaInterfaceWriter


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 package org.jboss.axis.wsdl.toJava;
56
57 import org.jboss.axis.wsdl.symbolTable.BindingEntry;
58 import org.jboss.axis.wsdl.symbolTable.Parameters;
59 import org.jboss.axis.wsdl.symbolTable.PortTypeEntry;
60 import org.jboss.axis.wsdl.symbolTable.SymbolTable;
61
62 import javax.wsdl.Operation;
63 import javax.wsdl.PortType;
64 import java.io.IOException JavaDoc;
65 import java.io.PrintWriter JavaDoc;
66 import java.util.Iterator JavaDoc;
67
68 /**
69  * This is Wsdl2java's PortType Writer. It writes the <portTypeName>.java file
70  * which contains the <portTypeName> interface.
71  */
72 public class JavaInterfaceWriter extends JavaClassWriter
73 {
74    protected PortType portType;
75    protected BindingEntry bEntry;
76
77    /**
78     * Constructor.
79     */
80    protected JavaInterfaceWriter(Emitter emitter,
81                                  PortTypeEntry ptEntry, BindingEntry bEntry, SymbolTable symbolTable)
82    {
83       super(emitter, (String JavaDoc)bEntry.getDynamicVar(JavaBindingWriter.INTERFACE_NAME), "interface");
84       this.portType = ptEntry.getPortType();
85       this.bEntry = bEntry;
86    } // ctor
87
88    /**
89     * Override generate method to prevent duplicate interfaces because
90     * of two bindings referencing the same portType
91     */
92    public void generate() throws IOException JavaDoc
93    {
94       String JavaDoc fqClass = getPackage() + "." + getClassName();
95
96       // Do not emit the same portType/interface twice
97 if (!emitter.getGeneratedFileInfo().getClassNames().contains(fqClass))
98       {
99          super.generate();
100       }
101    } // generate
102
103    /**
104     * Returns "interface ".
105     */
106    protected String JavaDoc getClassText()
107    {
108       return "interface ";
109    } // getClassString
110
111    /**
112     * Returns "extends java.rmi.Remote ".
113     */
114    protected String JavaDoc getExtendsText()
115    {
116       return "extends java.rmi.Remote ";
117    } // getExtendsText
118
119    /**
120     * Write the body of the portType interface file.
121     */
122    protected void writeFileBody(PrintWriter JavaDoc pw) throws IOException JavaDoc
123    {
124       Iterator JavaDoc operations = portType.getOperations().iterator();
125       while (operations.hasNext())
126       {
127          Operation operation = (Operation)operations.next();
128          writeOperation(pw, operation);
129       }
130    } // writeFileBody
131
132    /**
133     * This method generates the interface signatures for the given operation.
134     */
135    protected void writeOperation(PrintWriter JavaDoc pw, Operation operation) throws IOException JavaDoc
136    {
137       writeComment(pw, operation.getDocumentationElement());
138       Parameters parms = bEntry.getParameters(operation);
139       pw.println(parms.signature + ";");
140    } // writeOperation
141
142 } // class JavaInterfaceWriter
143
Popular Tags