Source for org.omg.DynamicAny.DynValueBoxOperations

   1: /* DynValueBoxOperation.java --
   2:    Copyright (C) 2005 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.DynamicAny;
  40: 
  41: import org.omg.CORBA.Any;
  42: import org.omg.DynamicAny.DynAnyPackage.InvalidValue;
  43: import org.omg.DynamicAny.DynAnyPackage.TypeMismatch;
  44: 
  45: /**
  46:  * Defines operations, applicable for the boxed value type.
  47:  *
  48:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  49:  */
  50: public interface DynValueBoxOperations
  51:   extends DynValueCommonOperations, DynAnyOperations
  52: {
  53:   /**
  54:    * Get the return the content of the "box" as the DynAny.
  55:    *
  56:    * @throws InvalidValue if the object is holding <code>null</code>.
  57:    */
  58:   DynAny get_boxed_value_as_dyn_any()
  59:     throws InvalidValue;
  60: 
  61:   /**
  62:    * Get the return the content of the "box" as the Any.
  63:    *
  64:    * @throws InvalidValue if the object is holding <code>null</code>.
  65:    */
  66:   Any get_boxed_value()
  67:     throws InvalidValue;
  68: 
  69:   /**
  70:    * Set the value of the "box" from DynAny.
  71:    *
  72:    * @param boxIt a value to box.
  73:    *
  74:    * @throws TypeMismatch if the type is not matching the current boxed value
  75:    * type.
  76:    */
  77:   void set_boxed_value_as_dyn_any(DynAny boxIt)
  78:     throws TypeMismatch;
  79: 
  80:   /**
  81:    * Set the value of the "box" as Any.
  82:    *
  83:    * @param boxIt a value to place into the box.
  84:    *
  85:    * @throws TypeMismatch if the type is not matching the current boxed value
  86:    * type.
  87:    */
  88:   void set_boxed_value(Any boxIt)
  89:     throws TypeMismatch;
  90: 
  91: }