Package com.sun.xml.ws.api.model
Interface Parameter
-
- All Known Implementing Classes:
ParameterImpl,WrapperParameter
public interface ParameterRuntime 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 subclassWrapperParameteris used.- Author:
- Vivek Pandey
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description ParameterBindinggetBinding()Returns the binding associated with the parameter.BridgegetBridge()Deprecated.ObjectgetHolderValue(Object obj)Gets the holder value if applicable.ParameterBindinggetInBinding()Returns theParameterBindingassociated with the IN modeintgetIndex()Position of a parameter in the method signature.javax.jws.WebParam.ModegetMode()QNamegetName()ParameterBindinggetOutBinding()Returns theParameterBindingassociated with the OUT modeSEIModelgetOwner()Gets the rootSEIModelthat owns this model.JavaMethodgetParent()Gets the parentJavaMethodto which this parameter belongs.StringgetPartName()Gives the wsdl:part@name valuebooleanisIN()booleanisINOUT()booleanisOUT()booleanisResponse()If true, this parameter maps to the return value of a method invocation.booleanisReturnValue()Returns true if this parameter is bound to the return value from theJavaMethod.booleanisWrapperStyle()
-
-
-
Method Detail
-
getParent
JavaMethod getParent()
Gets the parentJavaMethodto which this parameter belongs.
-
getMode
javax.jws.WebParam.Mode getMode()
- Returns:
- Returns the mode, such as IN, OUT or INOUT.
-
getIndex
int getIndex()
Position of a parameter in the method signature. It would be -1 if the parameter is a return.- Returns:
- Returns the index.
-
isWrapperStyle
boolean isWrapperStyle()
- Returns:
- true if
this instanceofWrapperParameter.
-
isReturnValue
boolean isReturnValue()
Returns true if this parameter is bound to the return value from theJavaMethod.Just the convenience method for
getIndex()==-1
-
getBinding
ParameterBinding getBinding()
Returns the binding associated with the parameter. For IN parameter the binding will be same asgetInBinding(), for OUT parameter the binding will be same asgetOutBinding()and for INOUT parameter the binding will be same as callinggetInBinding()- Returns:
- the Binding for this Parameter. Returns
ParameterBinding.BODYby default.
-
getInBinding
ParameterBinding getInBinding()
Returns theParameterBindingassociated with the IN mode- Returns:
- the binding
-
getOutBinding
ParameterBinding getOutBinding()
Returns theParameterBindingassociated with the OUT mode- Returns:
- the binding
-
isIN
boolean isIN()
- Returns:
- true if the
WebParam.Modeassociated with the parameter isWebParam.Mode.INand false otherwise.
-
isOUT
boolean isOUT()
- Returns:
- true if the
WebParam.Modeassociated with the parameter isWebParam.Mode.OUTand false otherwise.
-
isINOUT
boolean isINOUT()
- Returns:
- true if the
WebParam.Modeassociated with the parameter isWebParam.Mode.INOUTand false otherwise.
-
isResponse
boolean isResponse()
If true, this parameter maps to the return value of a method invocation.JavaMethod#getResponseParameters()is guaranteed to have at most one suchParameter. Note that there coule be none, in which case the method returnsvoid.Other response parameters are bound to
Holder.
-
getHolderValue
Object getHolderValue(Object obj)
Gets the holder value if applicable. To be called for inbound client side message.- Parameters:
obj-- Returns:
- the holder value if applicable.
-
getPartName
String getPartName()
Gives the wsdl:part@name value- Returns:
- Value of
WebParam.partName()annotation if present, otherwise its the localname of the infoset associated with the parameter
-
-