Package com.sun.xml.ws.api.model

Interface Parameter

All Known Implementing Classes:
ParameterImpl, WrapperParameter
public interface Parameter
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 WrapperParameter is used.
Author:
Vivek Pandey

  • Method Details

    • getOwner

      SEIModel getOwner()
      Gets the root SEIModel that owns this model.

    • getParent

      JavaMethod getParent()
      Gets the parent JavaMethod to which this parameter belongs.

    • getName

      QName getName()
      Returns:
      Returns the QName of the payload/infoset of a SOAP body or header.

    • getBridge

      org.glassfish.jaxb.runtime.api.Bridge getBridge()
      Deprecated.
      Gives the Bridge associated with this Parameter

    • getMode

      jakarta.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 instanceof WrapperParameter.

    • isReturnValue

      boolean isReturnValue()
      Returns true if this parameter is bound to the return value from the JavaMethod.

      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 as getInBinding(), for OUT parameter the binding will be same as getOutBinding() and for INOUT parameter the binding will be same as calling getInBinding()
      Returns:
      the Binding for this Parameter. Returns ParameterBinding.BODY by default.

    • getInBinding

      ParameterBinding getInBinding()
      Returns the ParameterBinding associated with the IN mode
      Returns:
      the binding

    • getOutBinding

      ParameterBinding getOutBinding()
      Returns the ParameterBinding associated with the OUT mode
      Returns:
      the binding

    • isIN

      boolean isIN()
      Returns:
      true if the WebParam.Mode associated with the parameter is WebParam.Mode.IN and false otherwise.

    • isOUT

      boolean isOUT()
      Returns:
      true if the WebParam.Mode associated with the parameter is WebParam.Mode.OUT and false otherwise.

    • isINOUT

      boolean isINOUT()
      Returns:
      true if the WebParam.Mode associated with the parameter is WebParam.Mode.INOUT and false otherwise.

    • isResponse

      boolean isResponse()
      If true, this parameter maps to the return value of a method invocation.

      JavaMethod.getResponseMessageName() is guaranteed to have at most one such Parameter. Note that there could be none, in which case the method returns void.

      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