001 /* State.java -- 002 Copyright (C) 2005, 2006 Free Software Foundation, Inc. 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 039 package org.omg.PortableServer.POAManagerPackage; 040 041 import gnu.CORBA.Minor; 042 043 import org.omg.CORBA.BAD_OPERATION; 044 import org.omg.CORBA.BAD_PARAM; 045 import org.omg.CORBA.TRANSIENT; 046 import org.omg.CORBA.portable.IDLEntity; 047 048 import java.io.Serializable; 049 050 /** 051 * Defines the possible states of the POA manager. 052 * 053 * This enumeration can obtain the following values: 054 * <ul> 055 * <li>ACTIVE When the manager is in the active state, the associated POAs 056 * receive and process requests.</li> 057 * <li>DISCARDING When the manager is in the discarding state, 058 * the associated POAs discard all incoming requests. The sending clients 059 * receive the {@link TRANSIENT} system exception, with standard 060 * minor code 1. This mode is needed for flow control, when the system is 061 * flooded with requests. 062 * </li> 063 * <li>HOLDING When the manager is in the holding state, the associated POAs 064 * queue incoming requests.</li> 065 * <li>INACTIVE This state is entered when the associated POAs are to be 066 * shut down.</li> 067 * </ul> 068 * 069 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org) 070 */ 071 public class State 072 implements Serializable, IDLEntity 073 { 074 /** 075 * Use serialVersionUID (v1.4) for interoperability. 076 */ 077 private static final long serialVersionUID = -2451866258678193271L; 078 079 /** 080 * The value field for the current instance. 081 */ 082 private final int _value; 083 084 /** 085 * The possible value of this enumeration (HOLDING). 086 */ 087 public static final int _HOLDING = 0; 088 089 /** 090 * An instance of State, initialized to HOLDING. 091 */ 092 public static final State HOLDING = new State(_HOLDING); 093 094 /** 095 * The possible value of this enumeration (ACTIVE). 096 */ 097 public static final int _ACTIVE = 1; 098 099 /** 100 * An instance of State, initialized to ACTIVE. 101 */ 102 public static final State ACTIVE = new State(_ACTIVE); 103 104 /** 105 * The possible value of this enumeration (DISCARDING). 106 */ 107 public static final int _DISCARDING = 2; 108 109 /** 110 * An instance of State, initialized to DISCARDING. 111 */ 112 public static final State DISCARDING = new State(_DISCARDING); 113 114 /** 115 * The possible value of this enumeration (INACTIVE). 116 */ 117 public static final int _INACTIVE = 3; 118 119 /** 120 * An instance of State, initialized to INACTIVE. 121 */ 122 public static final State INACTIVE = new State(_INACTIVE); 123 124 /** 125 * The private array that maps integer codes to the enumeration 126 * values. 127 */ 128 private static final State[] enume = 129 new State[] { HOLDING, ACTIVE, DISCARDING, INACTIVE }; 130 131 /** 132 * The private array of state names. 133 */ 134 private static final String[] state_names = 135 new String[] { "HOLDING", "ACTIVE", "DISCARDING", "INACTIVE" }; 136 137 /** 138 * Normally, no new instances are required, so the constructor is protected. 139 */ 140 protected State(int a_value) 141 { 142 _value = a_value; 143 } 144 145 /** 146 * Returns the State, matching the given integer constant. 147 * 148 * @param code one of _HOLDING, _ACTIVE, _DISCARDING, _INACTIVE. 149 * @return one of HOLDING, ACTIVE, DISCARDING, INACTIVE. 150 * @throws BAD_PARAM if the parameter is not one of the valid values. 151 */ 152 public static State from_int(int code) 153 { 154 try 155 { 156 return enume[code]; 157 } 158 catch (ArrayIndexOutOfBoundsException ex) 159 { 160 BAD_OPERATION bad = new BAD_OPERATION("Invalid state " + code); 161 bad.minor = Minor.Enumeration; 162 throw bad; 163 } 164 } 165 166 /** 167 * Returns a short string representation. 168 * 169 * @return the name of the current enumeration value. 170 */ 171 public String toString() 172 { 173 return state_names [ _value ]; 174 } 175 176 /** 177 * Returns the integer code of the enumeration value. 178 * @return one of HOLDING, ACTIVE, DISCARDING, INACTIVE. 179 */ 180 public int value() 181 { 182 return _value; 183 } 184 }