Source for org.omg.PortableServer.RequestProcessingPolicyValue

   1: /* RequestProcessingPolicyValue.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 behaviour in the case when the
  48: * requested object is not found in the Active Object Map or that map
  49: * is not in use. The map is not in use when the
  50: * {@link ServantRetentionPolicyValue#NON_RETAIN} policy is active.
  51: * <ul>
  52: * <li>USE_ACTIVE_OBJECT_MAP_ONLY Raise an {@link org.omg.CORBA.OBJECT_NOT_EXIST}
  53: * with the minor code 2. {@link ServantRetentionPolicyValue#RETAIN} policy is
  54: * also required.
  55: * </li>
  56: * <li>USE_DEFAULT_SERVANT Dispatch request to the default servant. If no such
  57: * exists, raise {@link org.omg.CORBA.OBJ_ADAPTER} with minor code 3.
  58: * {@link IdUniquenessPolicyValue#MULTIPLE_ID} is also required.
  59: * </li>
  60: * <li>USE_SERVANT_MANAGER Dispatch request to the servant manager. If no such
  61: * exists, raise {@link org.omg.CORBA.OBJ_ADAPTER} with the minor code 4.</li>
  62: * </ul>
  63: *
  64: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  65: */
  66: public class RequestProcessingPolicyValue
  67:   implements Serializable, IDLEntity
  68: {
  69:   /**
  70:    * Use serialVersionUID (V1.4) for interoperability.
  71:    */
  72:   private static final long serialVersionUID = 7646563512329907695L;
  73: 
  74:   /**
  75:    * The value field for the current instance.
  76:    */
  77:   private final int _value;
  78: 
  79:   /**
  80:   * The possible value of this enumeration (USE_ACTIVE_OBJECT_MAP_ONLY).
  81:   */
  82:   public static final int _USE_ACTIVE_OBJECT_MAP_ONLY = 0;
  83: 
  84:   /**
  85:    * An instance of RequestProcessingPolicyValue, initialized to USE_ACTIVE_OBJECT_MAP_ONLY.
  86:    */
  87:   public static final RequestProcessingPolicyValue USE_ACTIVE_OBJECT_MAP_ONLY =
  88:     new RequestProcessingPolicyValue(_USE_ACTIVE_OBJECT_MAP_ONLY);
  89: 
  90:   /**
  91:   * The possible value of this enumeration (USE_DEFAULT_SERVANT).
  92:   */
  93:   public static final int _USE_DEFAULT_SERVANT = 1;
  94: 
  95:   /**
  96:    * An instance of RequestProcessingPolicyValue, initialized to USE_DEFAULT_SERVANT.
  97:    */
  98:   public static final RequestProcessingPolicyValue USE_DEFAULT_SERVANT =
  99:     new RequestProcessingPolicyValue(_USE_DEFAULT_SERVANT);
 100: 
 101:   /**
 102:   * The possible value of this enumeration (USE_SERVANT_MANAGER).
 103:   */
 104:   public static final int _USE_SERVANT_MANAGER = 2;
 105: 
 106:   /**
 107:    * An instance of RequestProcessingPolicyValue, initialized to USE_SERVANT_MANAGER.
 108:    */
 109:   public static final RequestProcessingPolicyValue USE_SERVANT_MANAGER =
 110:     new RequestProcessingPolicyValue(_USE_SERVANT_MANAGER);
 111: 
 112:   /**
 113:    * The private array that maps integer codes to the enumeration
 114:    * values.
 115:    */
 116:   private static final RequestProcessingPolicyValue[] enume =
 117:     new RequestProcessingPolicyValue[]
 118:     {
 119:       USE_ACTIVE_OBJECT_MAP_ONLY, USE_DEFAULT_SERVANT, USE_SERVANT_MANAGER
 120:     };
 121: 
 122:   /**
 123:    * The private array of state names.
 124:    */
 125:   private static final String[] state_names =
 126:     new String[]
 127:     {
 128:       "USE_ACTIVE_OBJECT_MAP_ONLY", "USE_DEFAULT_SERVANT", "USE_SERVANT_MANAGER"
 129:     };
 130: 
 131:   /**
 132:    * Normally, no new instances are required, so the constructor is protected.
 133:    */
 134:   protected RequestProcessingPolicyValue(int a_value)
 135:   {
 136:     _value = a_value;
 137:   }
 138: 
 139:   /**
 140:    * Returns the RequestProcessingPolicyValue, matching the given integer constant.
 141:    *
 142:    * @param code one of _USE_ACTIVE_OBJECT_MAP_ONLY, _USE_DEFAULT_SERVANT, _USE_SERVANT_MANAGER.
 143:    * @return one of USE_ACTIVE_OBJECT_MAP_ONLY, USE_DEFAULT_SERVANT, USE_SERVANT_MANAGER.
 144:    * @throws BAD_PARAM if the parameter is not one of the valid values.
 145:    */
 146:   public static RequestProcessingPolicyValue from_int(int code)
 147:   {
 148:     try
 149:       {
 150:         return enume [ code ];
 151:       }
 152:     catch (ArrayIndexOutOfBoundsException ex)
 153:       {
 154:         throw new BAD_OPERATION("Invalid enumeration code " + code);
 155:       }
 156:   }
 157: 
 158:   /**
 159:    * Returns a short string representation.
 160:    * @return the name of the current enumeration value.
 161:    */
 162:   public String toString()
 163:   {
 164:     return state_names [ _value ];
 165:   }
 166: 
 167:   /**
 168:    * Returns the integer code of the policy value.
 169:    * @return one of _USE_ACTIVE_OBJECT_MAP_ONLY,
 170:    * _USE_DEFAULT_SERVANT, _USE_SERVANT_MANAGER.
 171:    */
 172:   public int value()
 173:   {
 174:     return _value;
 175:   }