com.sun.xml.ws.api.model.Parameter Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 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 com.sun.xml.ws.api.model;
import com.sun.xml.bind.api.Bridge;
import javax.xml.namespace.QName;
import javax.xml.ws.Holder;
import javax.jws.WebParam;
import javax.jws.WebParam.Mode;
/**
* Runtime Parameter that abstracts the annotated java parameter
*
*
* A parameter may be bound to a header, a body, or an attachment.
* Note that when it's bound to a body, it's bound to a body,
* it binds to the whole payload.
*
*
* Sometimes multiple Java parameters are packed into the payload,
* in which case the subclass {@link com.sun.xml.ws.model.WrapperParameter} is used.
*
* @author Vivek Pandey
*/
public interface Parameter {
/**
* Gets the root {@link SEIModel} that owns this model.
*/
SEIModel getOwner();
/**
* Gets the parent {@link JavaMethod} to which this parameter belongs.
*/
JavaMethod getParent();
/**
* @return Returns the {@link QName} of the payload/infoset of a SOAP body or header.
*/
QName getName();
/**
* Gives the {@link Bridge} associated with this Parameter
* @deprecated
*/
Bridge getBridge();
/**
* @return Returns the mode, such as IN, OUT or INOUT.
*/
Mode getMode();
/**
* Position of a parameter in the method signature. It would be -1 if the parameter is a return.
*
* @return Returns the index.
*/
int getIndex();
/**
* @return true if {@code this instanceof} {@link com.sun.xml.ws.model.WrapperParameter}.
*/
boolean isWrapperStyle();
/**
* Returns true if this parameter is bound to the return value from the {@link JavaMethod}.
*
*
* Just the convenience method for {@code getIndex()==-1}
*/
boolean isReturnValue();
/**
* Returns the binding associated with the parameter. For IN parameter the binding will be
* same as {@link #getInBinding()}, for OUT parameter the binding will be same as
* {@link #getOutBinding()} and for INOUT parameter the binding will be same as calling
* {@link #getInBinding()}
*
* @return the Binding for this Parameter. Returns {@link ParameterBinding#BODY} by default.
*/
ParameterBinding getBinding();
/**
* Returns the {@link ParameterBinding} associated with the IN mode
*
* @return the binding
*/
ParameterBinding getInBinding();
/**
* Returns the {@link ParameterBinding} associated with the OUT mode
*
* @return the binding
*/
ParameterBinding getOutBinding();
/**
* @return true if the {@link Mode} associated with the parameter is {@link Mode#IN} and false otherwise.
*/
boolean isIN();
/**
* @return true if the {@link Mode} associated with the parameter is {@link Mode#OUT} and false otherwise.
*/
boolean isOUT();
/**
* @return true if the {@link Mode} associated with the parameter is {@link Mode#INOUT} and false otherwise.
*/
boolean isINOUT();
/**
* If true, this parameter maps to the return value of a method invocation.
*
*
* {@link JavaMethod#getResponseParameters()} is guaranteed to have
* at most one such {@link Parameter}. Note that there coule be none,
* in which case the method returns {@code void}.
*
*
* Other response parameters are bound to {@link Holder}.
*/
boolean isResponse();
/**
* Gets the holder value if applicable. To be called for inbound client side
* message.
*
* @param obj
* @return the holder value if applicable.
*/
Object getHolderValue(Object obj);
/**
* Gives the wsdl:part@name value
*
* @return Value of {@link WebParam#partName()} annotation if present,
* otherwise its the localname of the infoset associated with the parameter
*/
String getPartName();
}