Source for org.omg.PortableServer.POAManagerPackage.State

   1: /* State.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.POAManagerPackage;
  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:  * Defines the possible states of the POA manager.
  50:  *
  51:  * This enumeration can obtain the following values:
  52:  * <ul>
  53:  * <li>ACTIVE When the manager is in the active state, the associated POAs
  54:  * receive and process requests.</li>
  55:  * <li>DISCARDING When the manager is in the discarding state,
  56:  * the associated POAs discard all incoming requests. The sending clients
  57:  * receive the {@link org.omg.TRANSIENT} system exception, with standard
  58:  * minor code 1. This mode is needed for flow control, when the system is
  59:  * flooded with requests.
  60:  * </li>
  61:  * <li>HOLDING When the manager is in the holding state, the associated POAs
  62:  * queue incoming requests.</li>
  63:  * <li>INACTIVE This state is entered when the associated POAs are to be
  64:  *  shut down.</li>
  65:  * </ul>
  66:  *
  67:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  68:  */
  69: public class State
  70:   implements Serializable, IDLEntity
  71: {
  72:   /**
  73:    * Use serialVersionUID (v1.4) for interoperability.
  74:    */
  75:   private static final long serialVersionUID = -2451866258678193271L;
  76: 
  77:   /**
  78:    * The value field for the current instance.
  79:    */
  80:   private final int _value;
  81: 
  82:   /**
  83:   * The possible value of this enumeration (HOLDING).
  84:   */
  85:   public static final int _HOLDING = 0;
  86: 
  87:   /**
  88:    * An instance of State, initialized to HOLDING.
  89:    */
  90:   public static final State HOLDING = new State(_HOLDING);
  91: 
  92:   /**
  93:   * The possible value of this enumeration (ACTIVE).
  94:   */
  95:   public static final int _ACTIVE = 1;
  96: 
  97:   /**
  98:    * An instance of State, initialized to ACTIVE.
  99:    */
 100:   public static final State ACTIVE = new State(_ACTIVE);
 101: 
 102:   /**
 103:   * The possible value of this enumeration (DISCARDING).
 104:   */
 105:   public static final int _DISCARDING = 2;
 106: 
 107:   /**
 108:    * An instance of State, initialized to DISCARDING.
 109:    */
 110:   public static final State DISCARDING = new State(_DISCARDING);
 111: 
 112:   /**
 113:   * The possible value of this enumeration (INACTIVE).
 114:   */
 115:   public static final int _INACTIVE = 3;
 116: 
 117:   /**
 118:    * An instance of State, initialized to INACTIVE.
 119:    */
 120:   public static final State INACTIVE = new State(_INACTIVE);
 121: 
 122:   /**
 123:    * The private array that maps integer codes to the enumeration
 124:    * values.
 125:    */
 126:   private static final State[] enume =
 127:     new State[] { HOLDING, ACTIVE, DISCARDING, INACTIVE };
 128: 
 129:   /**
 130:    * The private array of state names.
 131:    */
 132:   private static final String[] state_names =
 133:     new String[] { "HOLDING", "ACTIVE", "DISCARDING", "INACTIVE" };
 134: 
 135:   /**
 136:    * Normally, no new instances are required, so the constructor is protected.
 137:    */
 138:   protected State(int a_value)
 139:   {
 140:     _value = a_value;
 141:   }
 142: 
 143:   /**
 144:    * Returns the State, matching the given integer constant.
 145:    * 
 146:    * @param code one of _HOLDING, _ACTIVE, _DISCARDING, _INACTIVE.
 147:    * @return one of HOLDING, ACTIVE, DISCARDING, INACTIVE.
 148:    * @throws BAD_PARAM if the parameter is not one of the valid values.
 149:    */
 150:   public static State from_int(int code)
 151:   {
 152:     try
 153:       {
 154:         return enume[code];
 155:       }
 156:     catch (ArrayIndexOutOfBoundsException ex)
 157:       {
 158:         BAD_OPERATION bad = new BAD_OPERATION("Invalid state " + code);
 159:         bad.minor = Minor.Enumeration;
 160:         throw bad;
 161:       }
 162:   }
 163: 
 164:   /**
 165:    * Returns a short string representation.
 166:    * 
 167:    * @return the name of the current enumeration value.
 168:    */
 169:   public String toString()
 170:   {
 171:     return state_names [ _value ];
 172:   }
 173: 
 174:   /**
 175:    * Returns the integer code of the enumeration value.
 176:    * @return one of HOLDING, ACTIVE, DISCARDING, INACTIVE.
 177:    */
 178:   public int value()
 179:   {
 180:     return _value;
 181:   }