Source for org.omg.DynamicAny.DynEnumOperations

   1: /* DynEnumOperations.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: This file is part of GNU Classpath.
   4: 
   5: GNU Classpath is free software; you can redistribute it and/or modify
   6: it under the terms of the GNU General Public License as published by
   7: the Free Software Foundation; either version 2, or (at your option)
   8: any later version.
   9: 
  10: GNU Classpath is distributed in the hope that it will be useful, but
  11: WITHOUT ANY WARRANTY; without even the implied warranty of
  12: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13: General Public License for more details.
  14: 
  15: You should have received a copy of the GNU General Public License
  16: along with GNU Classpath; see the file COPYING.  If not, write to the
  17: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18: 02110-1301 USA.
  19: 
  20: Linking this library statically or dynamically with other modules is
  21: making a combined work based on this library.  Thus, the terms and
  22: conditions of the GNU General Public License cover the whole
  23: combination.
  24: 
  25: As a special exception, the copyright holders of this library give you
  26: permission to link this library with independent modules to produce an
  27: executable, regardless of the license terms of these independent
  28: modules, and to copy and distribute the resulting executable under
  29: terms of your choice, provided that you also meet, for each linked
  30: independent module, the terms and conditions of the license of that
  31: module.  An independent module is a module which is not derived from
  32: or based on this library.  If you modify this library, you may extend
  33: this exception to your version of the library, but you are not
  34: obligated to do so.  If you do not wish to do so, delete this
  35: exception statement from your version. */
  36: 
  37: 
  38: package org.omg.DynamicAny;
  39: 
  40: import org.omg.DynamicAny.DynAnyPackage.InvalidValue;
  41: 
  42: /**
  43:  * Defines operations, applicable to the dynamic enumeration. The value of the
  44:  * dynamic enumeration can be set by name or by integer code. The valid string
  45:  * values and integer codes are taken from the typecode, from which the
  46:  * enumeration was constructed. The enumeration is an undividable type without
  47:  * traversable components.
  48:  *
  49:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  50:  */
  51: public interface DynEnumOperations
  52:   extends DynAnyOperations
  53: {
  54:   /**
  55:    * Get the current enumeration value, as string.
  56:    */
  57:   String get_as_string();
  58: 
  59:   /**
  60:    * Get the current enumeration value, as int.
  61:    */
  62:   int get_as_ulong();
  63: 
  64:   /**
  65:    * Set the current enumeration value, as string.
  66:    *
  67:    * @throws InvalidValue if the passed string is not one of the allowed values
  68:    * for this enumeration.
  69:    */
  70:   void set_as_string(String value)
  71:     throws InvalidValue;
  72: 
  73:   /**
  74:    * Set the current enumeration value, as int.
  75:    *
  76:    * @throws InvalidValue if the passed string is not one of the allowed values
  77:    * for this enumeration.
  78:    */
  79:   void set_as_ulong(int value)
  80:     throws InvalidValue;
  81: 
  82: }