Package org.apache.axis.description
Class ParameterDesc
java.lang.Object
org.apache.axis.description.ParameterDesc
- All Implemented Interfaces:
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 Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionParameterDesc
(QName name, byte mode, QName typeQName) ConstructorParameterDesc
(QName name, byte mode, QName typeQName, Class javaType) Deprecated.ParameterDesc
(QName name, byte mode, QName typeQName, Class javaType, boolean inHeader, boolean outHeader) "Complete" constructor, suitable for usage in skeleton codeParameterDesc
(ParameterDesc copy) Constructor-copy -
Method Summary
Modifier and TypeMethodDescriptionget the documentation for the parameterboolean
Indicates ParameterDesc represents return of OperationDescGet the java type (note that this is javaType in the signature.)byte
getMode()
static String
getModeAsString
(byte mode) getName()
int
getOrder()
getQName()
boolean
boolean
Indicates whether this parameter is nillable or not.boolean
Indicates if this parameter is omittable or not (i.e., if it has a minimum occurrence of 0).boolean
static byte
modeFromString
(String modeStr) Get a mode constant from a string.void
setDocumentation
(String documentation) set the documentation for the parametervoid
setInHeader
(boolean value) void
setIsReturn
(boolean value) Set to true to indicate return parameter of OperationDescvoid
setItemQName
(QName itemQName) void
setItemType
(QName itemType) void
setJavaType
(Class javaType) Set the java type (note that this is javaType in the signature.)void
setMode
(byte mode) void
void
setNillable
(boolean nillable) Indicate if this parameter is nillable.void
setOmittable
(boolean omittable) Indicate if this parameter is omittable or not (i.e., if it has a minimum occurrence of 0).void
setOrder
(int order) void
setOutHeader
(boolean value) void
void
setTypeQName
(QName typeQName) toString()
-
Field Details
-
IN
public static final byte IN- See Also:
-
OUT
public static final byte OUT- See Also:
-
INOUT
public static final byte INOUT- See Also:
-
typeEntry
A TypeEntry corresponding to this parameter
-
-
Constructor Details
-
ParameterDesc
public ParameterDesc() -
ParameterDesc
Constructor-copy- Parameters:
copy
- the copy
-
ParameterDesc
Constructor- Parameters:
name
- the parameter's fully qualified XML namemode
- IN, OUT, INOUTtypeQName
- 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 namemode
- IN, OUT, INOUTtypeQName
- the parameter's XML type QNamejavaType
- the parameter's javaTypeinHeader
- does this parameter go into the input message header?outHeader
- does this parameter go into the output message header?
-
ParameterDesc
Deprecated.- Parameters:
name
- the parameter's fully qualified XML namemode
- IN, OUT, INOUTtypeQName
- the parameter's XML type QNamejavaType
- the parameter's javaType
-
-
Method Details
-
toString
-
toString
-
modeFromString
Get a mode constant from a string. Defaults to IN, and returns OUT or INOUT if the string matches (ignoring case). -
getModeAsString
-
getQName
-
getName
-
setName
-
setQName
-
getTypeQName
-
setTypeQName
-
getJavaType
Get the java type (note that this is javaType in the signature.)- Returns:
- Class javaType
-
setJavaType
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
get the documentation for the parameter -
setDocumentation
set the documentation for the parameter -
getItemQName
-
setItemQName
-
getItemType
-
setItemType
-
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
-