libjava/classpath/org/omg/PortableServer/LifespanPolicyValue.java

   1 /* LifespanPolicyValue.java --
   2    Copyright (C) 2005, 2006 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.BAD_PARAM;
  45 import org.omg.CORBA.portable.IDLEntity;
  46
  47 import java.io.Serializable;
  48
  49 /**
  50 * Specifies the object life span policy.
  51 *
  52 * This enumeration can obtain the following values:
  53 * <ul>
  54 * <li>TRANSIENT The objects implemented in the POA never outlive
  55 *  the POA instance in which they are first created.</li>
  56 * <li>PERSISTENT The mentioned objects can outlive the process in
  57 * which they are first created.</li>
  58 * </ul>
  59 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  60 */
  61 public class LifespanPolicyValue
  62   implements Serializable, IDLEntity
  63 {
  64   /**
  65    * Use serialVersionUID (V1.4) for interoperability.
  66    */
  67   private static final long serialVersionUID = 6604562925399671611L;
  68
  69   /**
  70    * The value field for the current instance.
  71    */
  72   private final int _value;
  73
  74   /**
  75   * The possible value of this enumeration (TRANSIENT).
  76   */
  77   public static final int _TRANSIENT = 0;
  78
  79   /**
  80    * An instance of LifespanPolicyValue, initialized to TRANSIENT.
  81    */
  82   public static final LifespanPolicyValue TRANSIENT =
  83     new LifespanPolicyValue(_TRANSIENT);
  84
  85   /**
  86   * The possible value of this enumeration (PERSISTENT).
  87   */
  88   public static final int _PERSISTENT = 1;
  89
  90   /**
  91    * An instance of LifespanPolicyValue, initialized to PERSISTENT.
  92    */
  93   public static final LifespanPolicyValue PERSISTENT =
  94     new LifespanPolicyValue(_PERSISTENT);
  95
  96   /**
  97    * The private array that maps integer codes to the enumeration
  98    * values.
  99    */
 100   private static final LifespanPolicyValue[] enume =
 101     new LifespanPolicyValue[] { TRANSIENT, PERSISTENT };
 102
 103   /**
 104    * The private array of state names.
 105    */
 106   private static final String[] state_names =
 107     new String[] { "TRANSIENT", "PERSISTENT" };
 108
 109   /**
 110    * Normally, no new instances are required, so the constructor is protected.
 111    */
 112   protected LifespanPolicyValue(int a_value)
 113   {
 114     _value = a_value;
 115   }
 116
 117   /**
 118    * Returns the LifespanPolicyValue, matching the given integer constant.
 119    *
 120    * @param code one of _TRANSIENT, _PERSISTENT.
 121    * @return one of TRANSIENT, PERSISTENT.
 122    * @throws BAD_PARAM if the parameter is not one of the valid values.
 123    */
 124   public static LifespanPolicyValue from_int(int code)
 125   {
 126     try
 127       {
 128         return enume [ code ];
 129       }
 130     catch (ArrayIndexOutOfBoundsException ex)
 131       {
 132         BAD_OPERATION bad = new BAD_OPERATION("Invalid policy code " + code);
 133         bad.minor = Minor.PolicyType;
 134         throw bad;
 135       }
 136   }
 137
 138   /**
 139    * Returns a short string representation.
 140    * @return the name of the current enumeration value.
 141    */
 142   public String toString()
 143   {
 144     return state_names [ _value ];
 145   }
 146
 147   /**
 148    * Returns the integer code of the policy value.
 149    * @return _TRANSIENT or _PERSISTENT.
 150    */
 151   public int value()
 152   {
 153     return _value;
 154   }
 155 }