Source for org.omg.DynamicAny.DynValueCommon

   1: /* DynValueCommon.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.portable.IDLEntity;
  42: 
  43: import java.io.Serializable;
  44: 
  45: /**
  46:  * Defines DynAny that may hold CORBA <code>null</code>. The
  47:  * {@link DynValueCommonOperations} provides methods for setting the value to
  48:  * <code>null</code> or non-<code>null</code> and checking if the value is
  49:  * <code>null</code>.
  50:  *
  51:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  52:  */
  53: public interface DynValueCommon
  54:   extends DynValueCommonOperations, DynAny, IDLEntity, org.omg.CORBA.Object,
  55:   Serializable
  56: {
  57:   /**
  58:    * Check if this {@link DynAny} is holding the <code>null</code>.
  59:    *
  60:    * @return true if this {@link DynAny} is holding the <code>null</code>,
  61:    * false otherwise.
  62:    */
  63:   boolean is_null();
  64: 
  65:   /**
  66:    * Set the value of this {@link DynAny} to CORBA <code>null</code>.
  67:    */
  68:   void set_to_null();
  69: 
  70:   /**
  71:    * Set the value of this {@link DynAny} to the default non-null value. The
  72:    * target {@link DynAny} creates a new data structure, intialised to the
  73:    * agreed default values, as defined in {@link DynAnyFactoryOperations}.
  74:    */
  75:   void set_to_value();
  76: }