org.omg.PortableServer
Class ServantRetentionPolicyValue

java.lang.Object
  extended by org.omg.PortableServer.ServantRetentionPolicyValue
All Implemented Interfaces:
Serializable, IDLEntity

public class ServantRetentionPolicyValue
extends Object
implements Serializable, IDLEntity

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

See Also:
Serialized Form

Field Summary
static int _NON_RETAIN
          The possible value of this enumeration (NON_RETAIN).
static int _RETAIN
          The possible value of this enumeration (RETAIN).
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.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_RETAIN

public static final int _RETAIN
The possible value of this enumeration (RETAIN).

See Also:
Constant Field Values

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

See Also:
Constant Field Values

NON_RETAIN

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

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.

Overrides:
toString in class Object
Returns:
the name of the current enumeration value.
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

value

public int value()
Returns the integer code of the policy value.

Returns:
_RETAIN or _NON_RETAIN.