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