org.omg.PortableServer

Class ServantRetentionPolicyValue

public class ServantRetentionPolicyValue extends Object implements Serializable, IDLEntity

Specifies the servant retention policy. This enumeration can obtain the following values:

RETAIN The POA retains active servants in its Active Object Map.
NON_RETAIN The servants are not retained.

Field Summary
static ServantRetentionPolicyValue	NON_RETAIN An instance of ServantRetentionPolicyValue, indicating that the POA does not use the Active Object Map.
static ServantRetentionPolicyValue	RETAIN An instance of ServantRetentionPolicyValue, indicating that the POA retains active servants in its Active Object Map.
static int	_NON_RETAIN The possible value of this enumeration (NON_RETAIN).
static int	_RETAIN The possible value of this enumeration (RETAIN).

Constructor Summary
protected	ServantRetentionPolicyValue(int a_value) Normally, no new instances are required, so the constructor is protected.

Method Summary
static ServantRetentionPolicyValue	from_int(int code) Returns the ServantRetentionPolicyValue, matching the given integer constant.
String	toString() Returns a short string representation.
int	value() Returns the integer code of the policy value.

Field Detail

NON_RETAIN

public static final ServantRetentionPolicyValue NON_RETAIN

An instance of ServantRetentionPolicyValue, indicating that the POA does not use the Active Object Map.

RETAIN

public static final ServantRetentionPolicyValue RETAIN

An instance of ServantRetentionPolicyValue, indicating that the POA retains active servants in its Active Object Map.

_NON_RETAIN

public static final int _NON_RETAIN

The possible value of this enumeration (NON_RETAIN).

_RETAIN

public static final int _RETAIN

The possible value of this enumeration (RETAIN).

Constructor Detail

ServantRetentionPolicyValue

protected ServantRetentionPolicyValue(int a_value)

Normally, no new instances are required, so the constructor is protected.

Method Detail

from_int

public static ServantRetentionPolicyValue from_int(int code)

Returns the ServantRetentionPolicyValue, matching the given integer constant.

Parameters: code one of _RETAIN, _NON_RETAIN.

Returns: one of RETAIN, NON_RETAIN.

Throws: BAD_PARAM if the parameter is not one of the valid values.

toString

public String toString()

Returns a short string representation.

Returns: the name of the current enumeration value.

value

public int value()

Returns the integer code of the policy value.

Returns: _RETAIN or _NON_RETAIN.