< prev index next >

src/java.xml.ws/share/classes/com/sun/xml/internal/ws/api/model/Parameter.java

Print this page




  64 
  65     /**
  66      * Gives the {@link Bridge} associated with this Parameter
  67      * @deprecated
  68      */
  69     Bridge getBridge();
  70 
  71     /**
  72      * @return Returns the mode, such as IN, OUT or INOUT.
  73      */
  74     Mode getMode();
  75 
  76     /**
  77      * Position of a parameter in the method signature. It would be -1 if the parameter is a return.
  78      *
  79      * @return Returns the index.
  80      */
  81     int getIndex();
  82 
  83     /**
  84      * @return true if <tt>this instanceof {@link com.sun.xml.internal.ws.model.WrapperParameter}</tt>.
  85      */
  86     boolean isWrapperStyle();
  87 
  88     /**
  89      * Returns true if this parameter is bound to the return value from the {@link JavaMethod}.
  90      *
  91      * <p>
  92      * Just the convenience method for <tt>getIndex()==-1</tt>
  93      */
  94     boolean isReturnValue();
  95 
  96     /**
  97      * Returns the binding associated with the parameter. For IN parameter the binding will be
  98      * same as {@link #getInBinding()}, for OUT parameter the binding will be same as
  99      * {@link #getOutBinding()} and for INOUT parameter the binding will be same as calling
 100      * {@link #getInBinding()}
 101      *
 102      * @return the Binding for this Parameter. Returns {@link ParameterBinding#BODY} by default.
 103      */
 104     ParameterBinding getBinding();
 105 
 106     /**
 107      * Returns the {@link ParameterBinding} associated with the IN mode
 108      *
 109      * @return the binding
 110      */
 111     ParameterBinding getInBinding();
 112 


 121      * @return true if the {@link Mode} associated with the parameter is {@link Mode#IN} and false otherwise.
 122      */
 123     boolean isIN();
 124 
 125     /**
 126      * @return true if the {@link Mode} associated with the parameter is {@link Mode#OUT} and false otherwise.
 127      */
 128     boolean isOUT();
 129 
 130     /**
 131      * @return true if the {@link Mode} associated with the parameter is {@link Mode#INOUT} and false otherwise.
 132      */
 133     boolean isINOUT();
 134 
 135     /**
 136      * If true, this parameter maps to the return value of a method invocation.
 137      *
 138      * <p>
 139      * {@link JavaMethod#getResponseParameters()} is guaranteed to have
 140      * at most one such {@link Parameter}. Note that there coule be none,
 141      * in which case the method returns <tt>void</tt>.
 142      *
 143      * <p>
 144      * Other response parameters are bound to {@link Holder}.
 145      */
 146     boolean isResponse();
 147 
 148     /**
 149      * Gets the holder value if applicable. To be called for inbound client side
 150      * message.
 151      *
 152      * @param obj
 153      * @return the holder value if applicable.
 154      */
 155     Object getHolderValue(Object obj);
 156 
 157     /**
 158      * Gives the wsdl:part@name value
 159      *
 160      * @return Value of {@link WebParam#partName()} annotation if present,
 161      *         otherwise its the localname of the infoset associated with the parameter


  64 
  65     /**
  66      * Gives the {@link Bridge} associated with this Parameter
  67      * @deprecated
  68      */
  69     Bridge getBridge();
  70 
  71     /**
  72      * @return Returns the mode, such as IN, OUT or INOUT.
  73      */
  74     Mode getMode();
  75 
  76     /**
  77      * Position of a parameter in the method signature. It would be -1 if the parameter is a return.
  78      *
  79      * @return Returns the index.
  80      */
  81     int getIndex();
  82 
  83     /**
  84      * @return true if {@code this instanceof} {@link com.sun.xml.internal.ws.model.WrapperParameter}.
  85      */
  86     boolean isWrapperStyle();
  87 
  88     /**
  89      * Returns true if this parameter is bound to the return value from the {@link JavaMethod}.
  90      *
  91      * <p>
  92      * Just the convenience method for {@code getIndex()==-1}
  93      */
  94     boolean isReturnValue();
  95 
  96     /**
  97      * Returns the binding associated with the parameter. For IN parameter the binding will be
  98      * same as {@link #getInBinding()}, for OUT parameter the binding will be same as
  99      * {@link #getOutBinding()} and for INOUT parameter the binding will be same as calling
 100      * {@link #getInBinding()}
 101      *
 102      * @return the Binding for this Parameter. Returns {@link ParameterBinding#BODY} by default.
 103      */
 104     ParameterBinding getBinding();
 105 
 106     /**
 107      * Returns the {@link ParameterBinding} associated with the IN mode
 108      *
 109      * @return the binding
 110      */
 111     ParameterBinding getInBinding();
 112 


 121      * @return true if the {@link Mode} associated with the parameter is {@link Mode#IN} and false otherwise.
 122      */
 123     boolean isIN();
 124 
 125     /**
 126      * @return true if the {@link Mode} associated with the parameter is {@link Mode#OUT} and false otherwise.
 127      */
 128     boolean isOUT();
 129 
 130     /**
 131      * @return true if the {@link Mode} associated with the parameter is {@link Mode#INOUT} and false otherwise.
 132      */
 133     boolean isINOUT();
 134 
 135     /**
 136      * If true, this parameter maps to the return value of a method invocation.
 137      *
 138      * <p>
 139      * {@link JavaMethod#getResponseParameters()} is guaranteed to have
 140      * at most one such {@link Parameter}. Note that there coule be none,
 141      * in which case the method returns {@code void}.
 142      *
 143      * <p>
 144      * Other response parameters are bound to {@link Holder}.
 145      */
 146     boolean isResponse();
 147 
 148     /**
 149      * Gets the holder value if applicable. To be called for inbound client side
 150      * message.
 151      *
 152      * @param obj
 153      * @return the holder value if applicable.
 154      */
 155     Object getHolderValue(Object obj);
 156 
 157     /**
 158      * Gives the wsdl:part@name value
 159      *
 160      * @return Value of {@link WebParam#partName()} annotation if present,
 161      *         otherwise its the localname of the infoset associated with the parameter
< prev index next >