Source for org.omg.CORBA.DynStruct

   1: /* DynStruct.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: import org.omg.CORBA.DynAnyPackage.InvalidSeq;
  42: 
  43: /**
  44:  * Represents the {@link DynAny}, holding the CORBA structure (record
  45:  * with the named fields). The internal reference, described in
  46:  * {@link DynAny#current_component()}, iterates over the fields of the
  47:  * structure.
  48:  *
  49:  * @deprecated by {@link org.omg.DynamicAny.DynStruct}
  50:  *
  51:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  52:  */
  53: public interface DynStruct
  54:   extends DynAny
  55: {
  56: /**
  57:  * Get the kind of the structure field that would be returned by
  58:  * {@link DynAny#current_component()}.
  59:  *
  60:  * @return the kind of the structure field.
  61:  */
  62:   TCKind current_member_kind();
  63: 
  64:   /**
  65:    * Get the name of the structure field that would be returned by
  66:    * {@link DynAny#current_component()}.
  67:    *
  68:    * @return the name of the structure field.
  69:    */
  70:   String current_member_name();
  71: 
  72:   /**
  73:    * Get all fields of the structure in the array of the named values,
  74:    * holding name, repository id and value of the associated field.
  75:    *
  76:    * @return members the array of the named values,
  77:    * representing the structure fields.
  78:    */
  79:   NameValuePair[] get_members();
  80: 
  81:   /**
  82:    * Set all fields of this structure by name.
  83:    *
  84:    * @param members the array of the named values,
  85:    * representing the structure fields.
  86:    *
  87:    * @throws InvalidSeq if the passed argument is invalid.
  88:    */
  89:   void set_members(NameValuePair[] members)
  90:             throws InvalidSeq;
  91: }