Source for org.omg.PortableServer.ServantRetentionPolicyValue

   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 org.omg.CORBA.BAD_OPERATION;
  42: import org.omg.CORBA.portable.IDLEntity;
  43: 
  44: import java.io.Serializable;
  45: 
  46: /**
  47: * Specifies the servant retention policy.
  48: *
  49: * This enumeration can obtain the following values:
  50: * <ul>
  51: * <li>RETAIN The POA retains active servants in its Active Object Map.</li>
  52: * <li>NON_RETAIN The servants are not retained.</li>
  53: * </ul>
  54: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  55: */
  56: public class ServantRetentionPolicyValue
  57:   implements Serializable, IDLEntity
  58: {
  59:   /**
  60:    * Use serialVersionUID (V1.4) for interoperability.
  61:    */
  62:   private static final long serialVersionUID = -7476100336036943822L;
  63: 
  64:   /**
  65:    * The value field for the current instance.
  66:    */
  67:   private final int _value;
  68: 
  69:   /**
  70:   * The possible value of this enumeration (RETAIN).
  71:   */
  72:   public static final int _RETAIN = 0;
  73: 
  74:   /**
  75:    * An instance of ServantRetentionPolicyValue, indicating that
  76:    * the POA retains active servants in its Active Object Map.
  77:    */
  78:   public static final ServantRetentionPolicyValue RETAIN =
  79:     new ServantRetentionPolicyValue(_RETAIN);
  80: 
  81:   /**
  82:   * The possible value of this enumeration (NON_RETAIN).
  83:   */
  84:   public static final int _NON_RETAIN = 1;
  85: 
  86:   /**
  87:    * An instance of ServantRetentionPolicyValue, indicating that
  88:    * the POA does not use the Active Object Map.
  89:    */
  90:   public static final ServantRetentionPolicyValue NON_RETAIN =
  91:     new ServantRetentionPolicyValue(_NON_RETAIN);
  92: 
  93:   /**
  94:    * The private array that maps integer codes to the enumeration
  95:    * values.
  96:    */
  97:   private static final ServantRetentionPolicyValue[] enume =
  98:     new ServantRetentionPolicyValue[] { RETAIN, NON_RETAIN };
  99: 
 100:   /**
 101:    * The private array of state names.
 102:    */
 103:   private static final String[] state_names =
 104:     new String[] { "RETAIN", "NON_RETAIN" };
 105: 
 106:   /**
 107:    * Normally, no new instances are required, so the constructor is protected.
 108:    */
 109:   protected ServantRetentionPolicyValue(int a_value)
 110:   {
 111:     _value = a_value;
 112:   }
 113: 
 114:   /**
 115:    * Returns the ServantRetentionPolicyValue, matching the given integer constant.
 116:    *
 117:    * @param code one of _RETAIN, _NON_RETAIN.
 118:    * @return one of RETAIN, NON_RETAIN.
 119:    * @throws BAD_PARAM if the parameter is not one of the valid values.
 120:    */
 121:   public static ServantRetentionPolicyValue 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 _RETAIN or _NON_RETAIN.
 145:    */
 146:   public int value()
 147:   {
 148:     return _value;
 149:   }