Source for org.omg.PortableServer.IdUniquenessPolicyValue

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