org.apache.axis.description

Class ParameterDesc

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)

Field Summary
static byteIN
static byteINOUT
static byteOUT
TypeEntrytypeEntry
A TypeEntry corresponding to this parameter
Constructor Summary
ParameterDesc()
ParameterDesc(ParameterDesc copy)
Constructor-copy
ParameterDesc(QName name, byte mode, QName typeQName)
Constructor
ParameterDesc(QName name, byte mode, QName typeQName, Class javaType, boolean inHeader, boolean outHeader)
"Complete" constructor, suitable for usage in skeleton code
ParameterDesc(QName name, byte mode, QName typeQName, Class javaType)
Method Summary
StringgetDocumentation()
get the documentation for the parameter
booleangetIsReturn()
Indicates ParameterDesc represents return of OperationDesc
QNamegetItemQName()
QNamegetItemType()
ClassgetJavaType()
Get the java type (note that this is javaType in the signature.)
bytegetMode()
static StringgetModeAsString(byte mode)
StringgetName()
intgetOrder()
QNamegetQName()
QNamegetTypeQName()
booleanisInHeader()
booleanisOutHeader()
static bytemodeFromString(String modeStr)
Get a mode constant from a string.
voidsetDocumentation(String documentation)
set the documentation for the parameter
voidsetInHeader(boolean value)
voidsetIsReturn(boolean value)
Set to true to indicate return parameter of OperationDesc
voidsetItemQName(QName itemQName)
voidsetItemType(QName itemType)
voidsetJavaType(Class javaType)
Set the java type (note that this is javaType in the signature.)
voidsetMode(byte mode)
voidsetName(String name)
voidsetOrder(int order)
voidsetOutHeader(boolean value)
voidsetQName(QName name)
voidsetTypeQName(QName typeQName)
StringtoString()
StringtoString(String indent)

Field Detail

IN

public static final byte IN

INOUT

public static final byte INOUT

OUT

public static final byte OUT

typeEntry

public TypeEntry typeEntry
A TypeEntry corresponding to this parameter

Constructor Detail

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 Detail

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

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)

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.