Package org.apache.axis.description

Class ParameterDesc

java.lang.Object
org.apache.axis.description.ParameterDesc
All Implemented Interfaces:
Serializable
public class ParameterDesc extends Object implements Serializable
A Parameter descriptor, collecting the interesting info about an operation parameter. (mostly taken from org.apache.axis.wsdl.toJava.Parameter right now)
Author:
Glen Daniels (gdaniels@apache.org)
See Also:

  • Field Details

  • Constructor Details

    • ParameterDesc

      public ParameterDesc()

    • ParameterDesc

      public ParameterDesc(ParameterDesc copy)
      Constructor-copy
      Parameters:
      copy - the copy

    • ParameterDesc

      public ParameterDesc(QName name, byte mode, QName typeQName)
      Constructor
      Parameters:
      name - the parameter's fully qualified XML name
      mode - IN, OUT, INOUT
      typeQName - the parameter's XML type QName

    • ParameterDesc

      public ParameterDesc(QName name, byte mode, QName typeQName, Class javaType, boolean inHeader, boolean outHeader)
      "Complete" constructor, suitable for usage in skeleton code
      Parameters:
      name - the parameter's fully qualified XML name
      mode - IN, OUT, INOUT
      typeQName - the parameter's XML type QName
      javaType - the parameter's javaType
      inHeader - does this parameter go into the input message header?
      outHeader - does this parameter go into the output message header?

    • ParameterDesc

      public ParameterDesc(QName name, byte mode, QName typeQName, Class javaType)
      Deprecated.
      Parameters:
      name - the parameter's fully qualified XML name
      mode - IN, OUT, INOUT
      typeQName - the parameter's XML type QName
      javaType - the parameter's javaType

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(String indent)

    • modeFromString

      public static byte modeFromString(String modeStr)
      Get a mode constant from a string. Defaults to IN, and returns OUT or INOUT if the string matches (ignoring case).

    • getModeAsString

      public static String getModeAsString(byte mode)

    • getQName

      public QName getQName()

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • setQName

      public void setQName(QName name)

    • getTypeQName

      public QName getTypeQName()

    • setTypeQName

      public void setTypeQName(QName typeQName)

    • getJavaType

      public Class getJavaType()
      Get the java type (note that this is javaType in the signature.)
      Returns:
      Class javaType

    • setJavaType

      public void setJavaType(Class javaType)
      Set the java type (note that this is javaType in the signature.)

    • getMode

      public byte getMode()

    • setMode

      public void setMode(byte mode)

    • getOrder

      public int getOrder()

    • setOrder

      public void setOrder(int order)

    • setInHeader

      public void setInHeader(boolean value)

    • isInHeader

      public boolean isInHeader()

    • setOutHeader

      public void setOutHeader(boolean value)

    • isOutHeader

      public boolean isOutHeader()

    • getIsReturn

      public boolean getIsReturn()
      Indicates ParameterDesc represents return of OperationDesc
      Returns:
      true if return parameter of OperationDesc

    • setIsReturn

      public void setIsReturn(boolean value)
      Set to true to indicate return parameter of OperationDesc
      Parameters:
      value - boolean that indicates if return parameter of OperationDesc

    • getDocumentation

      public String getDocumentation()
      get the documentation for the parameter

    • setDocumentation

      public void setDocumentation(String documentation)
      set the documentation for the parameter

    • getItemQName

      public QName getItemQName()

    • setItemQName

      public void setItemQName(QName itemQName)

    • getItemType

      public QName getItemType()

    • setItemType

      public void setItemType(QName itemType)

    • isOmittable

      public boolean isOmittable()
      Indicates if this parameter is omittable or not (i.e., if it has a minimum occurrence of 0).
      Returns:
      true iff the parameter may be omitted in the request

    • setOmittable

      public void setOmittable(boolean omittable)
      Indicate if this parameter is omittable or not (i.e., if it has a minimum occurrence of 0).
      Parameters:
      omittable - whether the parameter may be omitted or not

    • isNillable

      public boolean isNillable()
      Indicates whether this parameter is nillable or not.
      Returns:
      whether this parameter is nillable

    • setNillable

      public void setNillable(boolean nillable)
      Indicate if this parameter is nillable.
      Parameters:
      nillable - true iff this parameter is nillable