Source for org.omg.PortableServer.IdUniquenessPolicyValue

   1: /* IdUniquenessPolicyValue.java --
   2:    Copyright (C) 2005, 2006 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 gnu.CORBA.Minor;
  42: 
  43: import org.omg.CORBA.BAD_OPERATION;
  44: import org.omg.CORBA.BAD_PARAM;
  45: import org.omg.CORBA.portable.IDLEntity;
  46: 
  47: import java.io.Serializable;
  48: 
  49: /**
  50: * Specifies the Object Id uniqueness policy.
  51: *
  52: * This enumeration can obtain the following values:
  53: * <ul>
  54: * <li>UNIQUE_ID a servant activated with that POA supports exactly one Object Id.
  55: * </li>
  56: * <li>MULTIPLE_ID a servant activated with that POA supports
  57: * multiple Object Ids.
  58: * </li>
  59: * </ul>
  60: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  61: */
  62: public class IdUniquenessPolicyValue
  63:   implements Serializable, IDLEntity
  64: {
  65:   /**
  66:    * Use serialVersionUID (V1.4) for interoperability.
  67:    */
  68:   private static final long serialVersionUID = 2698951826884611346L;
  69: 
  70:   /**
  71:    * The value field for the current instance.
  72:    */
  73:   private final int _value;
  74: 
  75:   /**
  76:   * The possible value of this enumeration (UNIQUE_ID).
  77:   */
  78:   public static final int _UNIQUE_ID = 0;
  79: 
  80:   /**
  81:    * Indicates that a servant activated with that POA, supports one and only
  82:    * one OBject Id.
  83:    */
  84:   public static final IdUniquenessPolicyValue UNIQUE_ID =
  85:     new IdUniquenessPolicyValue(_UNIQUE_ID);
  86: 
  87:   /**
  88:   * The possible value of this enumeration (MULTIPLE_ID).
  89:   */
  90:   public static final int _MULTIPLE_ID = 1;
  91: 
  92:   /**
  93:    * Indicates that a servant activated with that POA is able to support the
  94:    * multiple Object Ids.
  95:    */
  96:   public static final IdUniquenessPolicyValue MULTIPLE_ID =
  97:     new IdUniquenessPolicyValue(_MULTIPLE_ID);
  98: 
  99:   /**
 100:    * The private array that maps integer codes to the enumeration
 101:    * values.
 102:    */
 103:   private static final IdUniquenessPolicyValue[] enume =
 104:     new IdUniquenessPolicyValue[] { UNIQUE_ID, MULTIPLE_ID };
 105: 
 106:   /**
 107:    * The private array of state names.
 108:    */
 109:   private static final String[] state_names =
 110:     new String[] { "UNIQUE_ID", "MULTIPLE_ID" };
 111: 
 112:   /**
 113:    * Normally, no new instances are required, so the constructor is protected.
 114:    */
 115:   protected IdUniquenessPolicyValue(int a_value)
 116:   {
 117:     _value = a_value;
 118:   }
 119: 
 120:   /**
 121:    * Returns the IdUniquenessPolicyValue, matching the given integer constant.
 122:    *
 123:    * @param code one of _UNIQUE_ID, _MULTIPLE_ID.
 124:    * @return one of UNIQUE_ID, MULTIPLE_ID.
 125:    * @throws BAD_PARAM if the parameter is not one of the valid values.
 126:    */
 127:   public static IdUniquenessPolicyValue from_int(int code)
 128:   {
 129:     try
 130:       {
 131:         return enume [ code ];
 132:       }
 133:     catch (ArrayIndexOutOfBoundsException ex)
 134:       {
 135:         BAD_OPERATION bad = new BAD_OPERATION("Invalid policy code " + code);
 136:         bad.minor = Minor.PolicyType;
 137:         throw bad;
 138:       }
 139:   }
 140: 
 141:   /**
 142:    * Returns a short string representation.
 143:    * @return the name of the current enumeration value.
 144:    */
 145:   public String toString()
 146:   {
 147:     return state_names [ _value ];
 148:   }
 149: 
 150:   /**
 151:    * Returns the integer code of the policy value.
 152:    * @return _UNIQUE_ID or _MULTIPLE_ID.
 153:    */
 154:   public int value()
 155:   {
 156:     return _value;
 157:   }