org.omg.PortableServer

Class ServantRetentionPolicyValue

Implemented Interfaces:
IDLEntity, Serializable

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

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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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).
Field Value:
1

_RETAIN

public static final int _RETAIN
The possible value of this enumeration (RETAIN).
Field Value:
0

Constructor Details

ServantRetentionPolicyValue

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

Method Details

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 interface Object
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.

ServantRetentionPolicyValue.java -- Copyright (C) 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.