org.omg.CORBA
Class ParameterMode

java.lang.Object
  extended by org.omg.CORBA.ParameterMode
All Implemented Interfaces:
Serializable, IDLEntity

public class ParameterMode
extends Object
implements Serializable, IDLEntity

Defines the parameter modes (the ways in that a method parameter is used during invocation). In CORBA, a method parameter can pass the value (PARAM_IN), be used as a placeholder to return the value (PARAM_OUT) or both pass the data and be used as a placeholder to return the changed value (PARAM_INOUT).

See Also:
Serialized Form

Field Summary
static int _PARAM_IN
          This value means that the parameter is an IN parameter.
static int _PARAM_INOUT
          This value means that the parameter is an INOUT parameter.
static int _PARAM_OUT
          This value means that the parameter is an OUT parameter.
static ParameterMode PARAM_IN
          This value means that the parameter is an IN parameter.
static ParameterMode PARAM_INOUT
          This value means that the parameter is an INOUT parameter.
static ParameterMode PARAM_OUT
          This value means that the parameter is an OUT parameter.
 
Constructor Summary
protected ParameterMode(int a_value)
          Create an instance of the parameter mode with the given value.
 
Method Summary
static ParameterMode from_int(int p_mode)
          Get a parameter mode instance for the integer parameter mode code.
 int value()
          Return the integer value code for the given parameter mode.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_PARAM_IN

public static final int _PARAM_IN
This value means that the parameter is an IN parameter.

See Also:
Constant Field Values

_PARAM_OUT

public static final int _PARAM_OUT
This value means that the parameter is an OUT parameter.

See Also:
Constant Field Values

_PARAM_INOUT

public static final int _PARAM_INOUT
This value means that the parameter is an INOUT parameter.

See Also:
Constant Field Values

PARAM_IN

public static final ParameterMode PARAM_IN
This value means that the parameter is an IN parameter.


PARAM_OUT

public static final ParameterMode PARAM_OUT
This value means that the parameter is an OUT parameter.


PARAM_INOUT

public static final ParameterMode PARAM_INOUT
This value means that the parameter is an INOUT parameter.

Constructor Detail

ParameterMode

protected ParameterMode(int a_value)
Create an instance of the parameter mode with the given value.

Method Detail

value

public int value()
Return the integer value code for the given parameter mode.

Returns:
0 for PARAM_IN, 1 for PARAM_OUT, 3 for PARAM_INOUT.

from_int

public static ParameterMode from_int(int p_mode)
Get a parameter mode instance for the integer parameter mode code.

Parameters:
p_mode - a parameter mode (0..2).
Returns:
a corresponding parameter mode instance.
Throws:
BAD_PARAM - for the invalid parameter mode code.