Source for org.omg.PortableServer.LifespanPolicyValue

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