Source for org.omg.CORBA.DynEnum

   1: /* DynEnum.java --
   2:    Copyright (C) 2005, 2007 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.CORBA;
  40: 
  41: 
  42: /**
  43:  * Represents the dynamic enumeration, allowing to get/set the value by
  44:  * name or by position in the enumeration list. The CORBA enumeration
  45:  * can obtain one of the named values from the specified enumeration list.
  46:  *
  47:  * @deprecated by {@link org.omg.DynamicAny.DynEnum}
  48:  *
  49:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  50:  */
  51: public interface DynEnum
  52:   extends DynAny
  53: {
  54:   /**
  55:    * Get the value of this object.
  56:    * @return the currently set value, one of the allowed values
  57:    * for this enumeration.
  58:    */
  59:   String value_as_string();
  60: 
  61:   /**
  62:    * Set the value of this object.
  63:    *
  64:    * @param member the value to set, must be one of the allowed values for
  65:    * this enumeration. Otherwise the {@link SystemException} may be thrown.
  66:    */
  67:   void value_as_string(String member);
  68: 
  69:   /**
  70:    * Set the value of this object as the position inside the list of this
  71:    * enumeration.
  72:    *
  73:    * @param member the position of the enumeration value inside
  74:    * the enumeration list. Otherwise the {@link SystemException} may be thrown.
  75:    */
  76:   void value_as_ulong(int member);
  77: 
  78:   /**
  79:    * Get the value of this object as the position inside the list of this
  80:    * enumeration.
  81:    *
  82:    * @return member the position of the currently set enumeration value inside
  83:    * the enumeration list.
  84:    */
  85:   int value_as_ulong();
  86: }