oracle.panama.messaging.transport
Class Parameter

java.lang.Object
  |
  +--oracle.panama.messaging.transport.Parameter

public class Parameter

extends java.lang.Object

The parameter class is used to specify the parameters a driver takes.

Author:

jxiang

Constructor Summary

Parameter(java.lang.String name, java.lang.String desc, boolean mandatory, java.lang.String deft)
Constructor.

Method Summary

java.lang.String	getDefaultValue() Get the parameter default value.
java.lang.String	getDescription() Get the parameter description.
java.lang.String	getName() Get the parameter name.
boolean	isMandatory() Check if the parameter is mandatory.
boolean	isOptional() Check if the parameter is optional.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String desc,
                 boolean mandatory,
                 java.lang.String deft)

Constructor.

Parameters:

name - the parameter name.

desc - the parameter description.

mandatory - if the parameter is mandatory.

deft - the default value of the parameter.

Method Detail

getName

public java.lang.String getName()

Get the parameter name.

Returns:

the parameter name.

getDescription

public java.lang.String getDescription()

Get the parameter description.

Returns:

the parameter description.

isOptional

public boolean isOptional()

Check if the parameter is optional.

Returns:

true if it optional, false if it's mandatory.

isMandatory

public boolean isMandatory()

Check if the parameter is mandatory.

Returns:

true if it's mandatory, false if it's optional.

getDefaultValue

public java.lang.String getDefaultValue()

Get the parameter default value.

Returns:

the parameter default value.