Source for org.omg.DynamicAny.DynValueCommonOperations

   1: /* DynValueCommonOperations.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: /**
  42:  * Provides operations, applicable to {@link DynAny}s that may hold CORBA
  43:  * <code>null</code>.
  44:  *
  45:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  46:  */
  47: public interface DynValueCommonOperations
  48:   extends DynAnyOperations
  49: {
  50:   /**
  51:    * Check if this {@link DynAny} is holding the <code>null</code>.
  52:    *
  53:    * @return true if this {@link DynAny} is holding the <code>null</code>,
  54:    * false otherwise.
  55:    */
  56:   boolean is_null();
  57: 
  58:   /**
  59:    * Set the value of this {@link DynAny} to CORBA <code>null</code>.
  60:    */
  61:   void set_to_null();
  62: 
  63:   /**
  64:    * Set the value of this {@link DynAny} to the default non-null value. The
  65:    * target {@link DynAny} creates a new data structure, intialised to the
  66:    * agreed default values, as defined in {@link DynAnyFactoryOperations}.
  67:    */
  68:   void set_to_value();
  69: }