001/* DynUnion.java --
002   Copyright (C) 2005, 2007 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.CORBA;
040
041
042/**
043 * Represents the {@link DynAny}, holding the CORBA structure (variant record
044 * with the named fields). The internal reference, described in
045 * {@link DynAny#current_component()}, iterates over the fields of the
046 * member, stored in the union. The union always holds only one member;
047 * which one, depends from the value of the discriminator.
048 *
049 * @deprecated by {@link org.omg.DynamicAny.DynUnion}
050 *
051 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
052 */
053public interface DynUnion
054  extends DynAny
055{
056  /**
057   * Returns the discriminator, defining, which set of fields is stored.
058   * @return the discriminator.
059   */
060  DynAny discriminator();
061
062  /**
063   * Returns the discriminator kind.
064   */
065  TCKind discriminator_kind();
066
067  /**
068   * Returns the member, stored in this union.
069   */
070  DynAny member();
071
072  /**
073   * Returns the kind of the member, stored in this union.
074   */
075  TCKind member_kind();
076
077  /**
078   * Returns the name of the currently focused member.
079   */
080  String member_name();
081
082  /**
083   * Renames the currently focused member.
084   *
085   * @param new_name the new name of the currently focused member.
086   */
087  void member_name(String new_name);
088
089  /**
090   * Checks if the discriminator of this union has been assigned a valid
091   * default value.
092   */
093  boolean set_as_default();
094
095  /**
096   * Determines if the discriminator of this union gets assigned a valid
097   * default value.
098   * @param assign_default
099   */
100  void set_as_default(boolean assign_default);
101}