org.apache.axis.description

Class ParameterDesc

Implemented Interfaces:
Serializable

public class ParameterDesc
extends java.lang.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)

Field Summary

static byte
IN
static byte
INOUT
static byte
OUT
TypeEntry
typeEntry
A TypeEntry corresponding to this parameter

Constructor Summary

ParameterDesc()
ParameterDesc(QName name, byte mode, QName typeQName)
Constructor
ParameterDesc(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 code
ParameterDesc(ParameterDesc copy)
Constructor-copy

Method Summary

String
getDocumentation()
get the documentation for the parameter
boolean
getIsReturn()
Indicates ParameterDesc represents return of OperationDesc
QName
getItemQName()
QName
getItemType()
Class
getJavaType()
Get the java type (note that this is javaType in the signature.)
byte
getMode()
static String
getModeAsString(byte mode)
String
getName()
int
getOrder()
QName
getQName()
QName
getTypeQName()
boolean
isInHeader()
boolean
isNillable()
Indicates whether this parameter is nillable or not.
boolean
isOmittable()
Indicates if this parameter is omittable or not (i.e., if it has a minimum occurrence of 0).
boolean
isOutHeader()
static byte
modeFromString(String modeStr)
Get a mode constant from a string.
void
setDocumentation(String documentation)
set the documentation for the parameter
void
setInHeader(boolean value)
void
setIsReturn(boolean value)
Set to true to indicate return parameter of OperationDesc
void
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
setName(String name)
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
setQName(QName name)
void
setTypeQName(QName typeQName)
String
toString()
String
toString(String indent)

Field Details

IN

public static final byte IN
Field Value:
1

INOUT

public static final byte INOUT
Field Value:
3

OUT

public static final byte OUT
Field Value:
2

typeEntry

public TypeEntry typeEntry
A TypeEntry corresponding to this parameter

Constructor Details

ParameterDesc

public ParameterDesc()

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)

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

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(ParameterDesc copy)
Constructor-copy
Parameters:
copy - the copy

Method Details

getDocumentation

public String getDocumentation()
get the documentation for the parameter

getIsReturn

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

getItemQName

public QName getItemQName()

getItemType

public QName getItemType()

getJavaType

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

getMode

public byte getMode()

getModeAsString

public static String getModeAsString(byte mode)

getName

public String getName()

getOrder

public int getOrder()

getQName

public QName getQName()

getTypeQName

public QName getTypeQName()

isInHeader

public boolean isInHeader()

isNillable

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

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

isOutHeader

public boolean isOutHeader()

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).

setDocumentation

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

setInHeader

public void setInHeader(boolean value)

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

setItemQName

public void setItemQName(QName itemQName)

setItemType

public void setItemType(QName itemType)

setJavaType

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

setMode

public void setMode(byte mode)

setName

public void setName(String name)

setNillable

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

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

setOrder

public void setOrder(int order)

setOutHeader

public void setOutHeader(boolean value)

setQName

public void setQName(QName name)

setTypeQName

public void setTypeQName(QName typeQName)

toString

public String toString()

toString

public String toString(String indent)

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.