llvm-gcc-4.2/libjava/classpath/org/omg/CORBA/DynStruct.java

/* DynStruct.java --
   Copyright (C) 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package org.omg.CORBA;

import org.omg.CORBA.DynAnyPackage.InvalidSeq;

/**
 * Represents the {@link DynAny}, holding the CORBA structure (record
 * with the named fields). The internal reference, described in
 * {@link DynAny#current_component()}, iterates over the fields of the
 * structure.
 *
 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
 */
public interface DynStruct
  extends DynAny
{
/**
 * Get the kind of the structure field that would be returned by
 * {@link DynAny#current_component()}.
 *
 * @return the kind of the structure field.
 */
  TCKind current_member_kind();

  /**
   * Get the name of the structure field that would be returned by
   * {@link DynAny#current_component()}.
   *
   * @return the name of the structure field.
   */
  String current_member_name();

  /**
   * Get all fields of the structure in the array of the named values,
   * holding name, repository id and value of the associated field.
   *
   * @return members the array of the named values,
   * representing the structure fields.
   */
  NameValuePair[] get_members();

  /**
   * Set all fields of this structure by name.
   *
   * @param members the array of the named values,
   * representing the structure fields.
   *
   * @throws InvalidSeq if the passed argument is invalid.
   */
  void set_members(NameValuePair[] members)
            throws InvalidSeq;
}