Source for org.omg.CORBA.DynUnion

   1: /* DynUnion.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 {@link DynAny}, holding the CORBA structure (variant record
  44:  * with the named fields). The internal reference, described in
  45:  * {@link DynAny#current_component()}, iterates over the fields of the
  46:  * member, stored in the union. The union always holds only one member;
  47:  * which one, depends from the value of the discriminator.
  48:  *
  49:  * @deprecated by {@link org.omg.DynamicAny.DynUnion}
  50:  *
  51:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  52:  */
  53: public interface DynUnion
  54:   extends DynAny
  55: {
  56:   /**
  57:    * Returns the discriminator, defining, which set of fields is stored.
  58:    * @return the discriminator.
  59:    */
  60:   DynAny discriminator();
  61: 
  62:   /**
  63:    * Returns the discriminator kind.
  64:    */
  65:   TCKind discriminator_kind();
  66: 
  67:   /**
  68:    * Returns the member, stored in this union.
  69:    */
  70:   DynAny member();
  71: 
  72:   /**
  73:    * Returns the kind of the member, stored in this union.
  74:    */
  75:   TCKind member_kind();
  76: 
  77:   /**
  78:    * Returns the name of the currently focused member.
  79:    */
  80:   String member_name();
  81: 
  82:   /**
  83:    * Renames the currently focused member.
  84:    *
  85:    * @param new_name the new name of the currently focused member.
  86:    */
  87:   void member_name(String new_name);
  88: 
  89:   /**
  90:    * Checks if the discriminator of this union has been assigned a valid
  91:    * default value.
  92:    */
  93:   boolean set_as_default();
  94: 
  95:   /**
  96:    * Determines if the discriminator of this union gets assigned a valid
  97:    * default value.
  98:    * @param assign_default
  99:    */
 100:   void set_as_default(boolean assign_default);
 101: }