old-autovect-branch/libjava/classpath/org/omg/PortableServer/ServantRetentionPolicyValue.java

   1 /* ServantRetentionPolicyValue.java --
   2    Copyright (C) 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package org.omg.PortableServer;
  40
  41 import gnu.CORBA.Minor;
  42
  43 import org.omg.CORBA.BAD_OPERATION;
  44 import org.omg.CORBA.portable.IDLEntity;
  45
  46 import java.io.Serializable;
  47
  48 /**
  49 * Specifies the servant retention policy.
  50 *
  51 * This enumeration can obtain the following values:
  52 * <ul>
  53 * <li>RETAIN The POA retains active servants in its Active Object Map.</li>
  54 * <li>NON_RETAIN The servants are not retained.</li>
  55 * </ul>
  56 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  57 */
  58 public class ServantRetentionPolicyValue
  59   implements Serializable, IDLEntity
  60 {
  61   /**
  62    * Use serialVersionUID (V1.4) for interoperability.
  63    */
  64   private static final long serialVersionUID = -7476100336036943822L;
  65
  66   /**
  67    * The value field for the current instance.
  68    */
  69   private final int _value;
  70
  71   /**
  72   * The possible value of this enumeration (RETAIN).
  73   */
  74   public static final int _RETAIN = 0;
  75
  76   /**
  77    * An instance of ServantRetentionPolicyValue, indicating that
  78    * the POA retains active servants in its Active Object Map.
  79    */
  80   public static final ServantRetentionPolicyValue RETAIN =
  81     new ServantRetentionPolicyValue(_RETAIN);
  82
  83   /**
  84   * The possible value of this enumeration (NON_RETAIN).
  85   */
  86   public static final int _NON_RETAIN = 1;
  87
  88   /**
  89    * An instance of ServantRetentionPolicyValue, indicating that
  90    * the POA does not use the Active Object Map.
  91    */
  92   public static final ServantRetentionPolicyValue NON_RETAIN =
  93     new ServantRetentionPolicyValue(_NON_RETAIN);
  94
  95   /**
  96    * The private array that maps integer codes to the enumeration
  97    * values.
  98    */
  99   private static final ServantRetentionPolicyValue[] enume =
 100     new ServantRetentionPolicyValue[] { RETAIN, NON_RETAIN };
 101
 102   /**
 103    * The private array of state names.
 104    */
 105   private static final String[] state_names =
 106     new String[] { "RETAIN", "NON_RETAIN" };
 107
 108   /**
 109    * Normally, no new instances are required, so the constructor is protected.
 110    */
 111   protected ServantRetentionPolicyValue(int a_value)
 112   {
 113     _value = a_value;
 114   }
 115
 116   /**
 117    * Returns the ServantRetentionPolicyValue, matching the given integer constant.
 118    *
 119    * @param code one of _RETAIN, _NON_RETAIN.
 120    * @return one of RETAIN, NON_RETAIN.
 121    * @throws BAD_PARAM if the parameter is not one of the valid values.
 122    */
 123   public static ServantRetentionPolicyValue from_int(int code)
 124   {
 125     try
 126       {
 127         return enume [ code ];
 128       }
 129     catch (ArrayIndexOutOfBoundsException ex)
 130       {
 131         BAD_OPERATION bad = new BAD_OPERATION("Invalid policy code " + code);
 132         bad.minor = Minor.PolicyType;
 133         throw bad;
 134       }
 135   }
 136
 137   /**
 138    * Returns a short string representation.
 139    * @return the name of the current enumeration value.
 140    */
 141   public String toString()
 142   {
 143     return state_names [ _value ];
 144   }
 145
 146   /**
 147    * Returns the integer code of the policy value.
 148    * @return _RETAIN or _NON_RETAIN.
 149    */
 150   public int value()
 151   {
 152     return _value;
 153   }
 154 }