Parameter


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.symbolTable;
56  
57  import javax.xml.namespace.QName  ;
58  
59  /**
60   * This class simply collects
61   */
62  public class Parameter
63  {
64  
65     // constant values for the parameter mode.
66     public static final byte IN = 1;
67     public static final byte OUT = 2;
68     public static final byte INOUT = 3;
69  
70     // The QName of the element associated with this param.  Defaults to
71     // null, which means it'll be new QName("", name)
72     private QName   qname;
73  
74     // The part name of this parameter, just a string.
75     private String   name;
76  
77     // The MIME type of this parameter, null if it isn't a MIME type.
78     private MimeInfo mimeInfo = null;
79  
80     private TypeEntry type;
81     private byte mode = IN;
82  
83     // Flags indicating whether the parameter goes into the soap message as
84     // a header.
85     private boolean inHeader = false;
86     private boolean outHeader = false;
87  
88     public String   toString()
89     {
90        return "(" + type
91                + (mimeInfo == null ? "" : "(" + mimeInfo + ")")
92                + ", " + getName() + ", "
93                + (mode == IN ? "IN)" : mode == INOUT ? "INOUT)" : "OUT)"
94                + (inHeader ? "(IN soap:header)" : "")
95                + (outHeader ? "(OUT soap:header)" : ""));
96     } // toString
97  
98     /**
99      * Get the fully qualified name of this parameter.
100     */
101    public QName   getQName()
102    {
103       return qname;
104    }
105 
106    /**
107     * Get the name of this parameter.  This call is equivalent to
108     * getQName().getLocalPart().
109     */
110    public String   getName()
111    {
112       if (name == null && qname != null)
113       {
114          return qname.getLocalPart();
115       }
116       return name;
117    }
118 
119    /**
120     * Set the name of the parameter.  This replaces both the
121     * name and the QName (the namespaces becomes "").
122     */
123    public void setName(String   name)
124    {
125       this.name = name;
126       if (qname == null)
127          this.qname = new QName  ("", name);
128    }
129 
130    /**
131     * Set the QName of the parameter.
132     */
133    public void setQName(QName   qname)
134    {
135       this.qname = qname;
136    }
137 
138    /**
139     * Get the MIME type of the parameter.
140     */
141    public MimeInfo getMIMEInfo()
142    {
143       return mimeInfo;
144    } // getMIMEType
145 
146    /**
147     * Set the MIME type of the parameter.
148     */
149    public void setMIMEInfo(MimeInfo mimeInfo)
150    {
151       this.mimeInfo = mimeInfo;
152    } // setMIMEType
153 
154    /**
155     * Get the TypeEntry of the parameter.
156     */
157    public TypeEntry getType()
158    {
159       return type;
160    }
161 
162    /**
163     * Set the TypeEntry of the parameter.
164     */
165    public void setType(TypeEntry type)
166    {
167       this.type = type;
168    }
169 
170    /**
171     * Get the mode (IN, INOUT, OUT) of the parameter.
172     */
173    public byte getMode()
174    {
175       return mode;
176    }
177 
178    /**
179     * Set the mode (IN, INOUT, OUT) of the parameter.  If the input
180     * to this method is not one of IN, INOUT, OUT, then the value
181     * remains unchanged.
182     */
183    public void setMode(byte mode)
184    {
185       if (mode <= INOUT & mode >= IN)
186       {
187          this.mode = mode;
188       }
189    }
190 
191    /**
192     * Is this parameter in the input message header?
193     */
194    public boolean isInHeader()
195    {
196       return inHeader;
197    } // isInHeader
198 
199    /**
200     * Set the inHeader flag for this parameter.
201     */
202    public void setInHeader(boolean inHeader)
203    {
204       this.inHeader = inHeader;
205    } // setInHeader
206 
207    /**
208     * Is this parameter in the output message header?
209     */
210    public boolean isOutHeader()
211    {
212       return outHeader;
213    } // isOutHeader
214 
215    /**
216     * Set the outHeader flag for this parameter.
217     */
218    public void setOutHeader(boolean outHeader)
219    {
220       this.outHeader = outHeader;
221    } // setOutHeader
222 } // class Parameter
223
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags