Sat, 07 Nov 2020 10:30:02 +0800
Added tag mips-jdk8u275-b01 for changeset fdbe50121f48
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.ws.api.model; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import com.sun.xml.internal.bind.api.Bridge; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import javax.xml.namespace.QName; |
aoqi@0 | 31 | import javax.xml.ws.Holder; |
aoqi@0 | 32 | import javax.jws.WebParam; |
aoqi@0 | 33 | import javax.jws.WebParam.Mode; |
aoqi@0 | 34 | |
aoqi@0 | 35 | /** |
aoqi@0 | 36 | * Runtime Parameter that abstracts the annotated java parameter |
aoqi@0 | 37 | * <p/> |
aoqi@0 | 38 | * <p/> |
aoqi@0 | 39 | * A parameter may be bound to a header, a body, or an attachment. |
aoqi@0 | 40 | * Note that when it's bound to a body, it's bound to a body, |
aoqi@0 | 41 | * it binds to the whole payload. |
aoqi@0 | 42 | * <p/> |
aoqi@0 | 43 | * <p/> |
aoqi@0 | 44 | * Sometimes multiple Java parameters are packed into the payload, |
aoqi@0 | 45 | * in which case the subclass {@link com.sun.xml.internal.ws.model.WrapperParameter} is used. |
aoqi@0 | 46 | * |
aoqi@0 | 47 | * @author Vivek Pandey |
aoqi@0 | 48 | */ |
aoqi@0 | 49 | public interface Parameter { |
aoqi@0 | 50 | /** |
aoqi@0 | 51 | * Gets the root {@link SEIModel} that owns this model. |
aoqi@0 | 52 | */ |
aoqi@0 | 53 | SEIModel getOwner(); |
aoqi@0 | 54 | |
aoqi@0 | 55 | /** |
aoqi@0 | 56 | * Gets the parent {@link JavaMethod} to which this parameter belongs. |
aoqi@0 | 57 | */ |
aoqi@0 | 58 | JavaMethod getParent(); |
aoqi@0 | 59 | |
aoqi@0 | 60 | /** |
aoqi@0 | 61 | * @return Returns the {@link QName} of the payload/infoset of a SOAP body or header. |
aoqi@0 | 62 | */ |
aoqi@0 | 63 | QName getName(); |
aoqi@0 | 64 | |
aoqi@0 | 65 | /** |
aoqi@0 | 66 | * Gives the {@link Bridge} associated with this Parameter |
aoqi@0 | 67 | * @deprecated |
aoqi@0 | 68 | */ |
aoqi@0 | 69 | Bridge getBridge(); |
aoqi@0 | 70 | |
aoqi@0 | 71 | /** |
aoqi@0 | 72 | * @return Returns the mode, such as IN, OUT or INOUT. |
aoqi@0 | 73 | */ |
aoqi@0 | 74 | Mode getMode(); |
aoqi@0 | 75 | |
aoqi@0 | 76 | /** |
aoqi@0 | 77 | * Position of a parameter in the method signature. It would be -1 if the parameter is a return. |
aoqi@0 | 78 | * |
aoqi@0 | 79 | * @return Returns the index. |
aoqi@0 | 80 | */ |
aoqi@0 | 81 | int getIndex(); |
aoqi@0 | 82 | |
aoqi@0 | 83 | /** |
aoqi@0 | 84 | * @return true if <tt>this instanceof {@link com.sun.xml.internal.ws.model.WrapperParameter}</tt>. |
aoqi@0 | 85 | */ |
aoqi@0 | 86 | boolean isWrapperStyle(); |
aoqi@0 | 87 | |
aoqi@0 | 88 | /** |
aoqi@0 | 89 | * Returns true if this parameter is bound to the return value from the {@link JavaMethod}. |
aoqi@0 | 90 | * |
aoqi@0 | 91 | * <p> |
aoqi@0 | 92 | * Just the convenience method for <tt>getIndex()==-1</tt> |
aoqi@0 | 93 | */ |
aoqi@0 | 94 | boolean isReturnValue(); |
aoqi@0 | 95 | |
aoqi@0 | 96 | /** |
aoqi@0 | 97 | * Returns the binding associated with the parameter. For IN parameter the binding will be |
aoqi@0 | 98 | * same as {@link #getInBinding()}, for OUT parameter the binding will be same as |
aoqi@0 | 99 | * {@link #getOutBinding()} and for INOUT parameter the binding will be same as calling |
aoqi@0 | 100 | * {@link #getInBinding()} |
aoqi@0 | 101 | * |
aoqi@0 | 102 | * @return the Binding for this Parameter. Returns {@link ParameterBinding#BODY} by default. |
aoqi@0 | 103 | */ |
aoqi@0 | 104 | ParameterBinding getBinding(); |
aoqi@0 | 105 | |
aoqi@0 | 106 | /** |
aoqi@0 | 107 | * Returns the {@link ParameterBinding} associated with the IN mode |
aoqi@0 | 108 | * |
aoqi@0 | 109 | * @return the binding |
aoqi@0 | 110 | */ |
aoqi@0 | 111 | ParameterBinding getInBinding(); |
aoqi@0 | 112 | |
aoqi@0 | 113 | /** |
aoqi@0 | 114 | * Returns the {@link ParameterBinding} associated with the OUT mode |
aoqi@0 | 115 | * |
aoqi@0 | 116 | * @return the binding |
aoqi@0 | 117 | */ |
aoqi@0 | 118 | ParameterBinding getOutBinding(); |
aoqi@0 | 119 | |
aoqi@0 | 120 | /** |
aoqi@0 | 121 | * @return true if the {@link Mode} associated with the parameter is {@link Mode#IN} and false otherwise. |
aoqi@0 | 122 | */ |
aoqi@0 | 123 | boolean isIN(); |
aoqi@0 | 124 | |
aoqi@0 | 125 | /** |
aoqi@0 | 126 | * @return true if the {@link Mode} associated with the parameter is {@link Mode#OUT} and false otherwise. |
aoqi@0 | 127 | */ |
aoqi@0 | 128 | boolean isOUT(); |
aoqi@0 | 129 | |
aoqi@0 | 130 | /** |
aoqi@0 | 131 | * @return true if the {@link Mode} associated with the parameter is {@link Mode#INOUT} and false otherwise. |
aoqi@0 | 132 | */ |
aoqi@0 | 133 | boolean isINOUT(); |
aoqi@0 | 134 | |
aoqi@0 | 135 | /** |
aoqi@0 | 136 | * If true, this parameter maps to the return value of a method invocation. |
aoqi@0 | 137 | * |
aoqi@0 | 138 | * <p> |
aoqi@0 | 139 | * {@link JavaMethod#getResponseParameters()} is guaranteed to have |
aoqi@0 | 140 | * at most one such {@link Parameter}. Note that there coule be none, |
aoqi@0 | 141 | * in which case the method returns <tt>void</tt>. |
aoqi@0 | 142 | * |
aoqi@0 | 143 | * <p> |
aoqi@0 | 144 | * Other response parameters are bound to {@link Holder}. |
aoqi@0 | 145 | */ |
aoqi@0 | 146 | boolean isResponse(); |
aoqi@0 | 147 | |
aoqi@0 | 148 | /** |
aoqi@0 | 149 | * Gets the holder value if applicable. To be called for inbound client side |
aoqi@0 | 150 | * message. |
aoqi@0 | 151 | * |
aoqi@0 | 152 | * @param obj |
aoqi@0 | 153 | * @return the holder value if applicable. |
aoqi@0 | 154 | */ |
aoqi@0 | 155 | Object getHolderValue(Object obj); |
aoqi@0 | 156 | |
aoqi@0 | 157 | /** |
aoqi@0 | 158 | * Gives the wsdl:part@name value |
aoqi@0 | 159 | * |
aoqi@0 | 160 | * @return Value of {@link WebParam#partName()} annotation if present, |
aoqi@0 | 161 | * otherwise its the localname of the infoset associated with the parameter |
aoqi@0 | 162 | */ |
aoqi@0 | 163 | String getPartName(); |
aoqi@0 | 164 | } |