Source for org.omg.CORBA.Environment

   1: /* Environment.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.CORBA;
  40: 
  41: 
  42: /**
  43:  * A container for an exception, that has been thrown by the method
  44:  * of the CORBA object.
  45:  *
  46:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  47:  */
  48: public abstract class Environment
  49: {
  50:   /**
  51:    * Removes the exception object from this container.
  52:    */
  53:   public abstract void clear();
  54: 
  55:   /**
  56:    * Returns an exception, enclosed in this container.
  57:    *
  58:    * @return the enclosed exception or null if no any
  59:    * exception has been thrown or {@link #clear()}
  60:    * has been previously called.
  61:    */
  62:   public abstract Exception exception();
  63: 
  64:   /**
  65:    * Inserts the given exception into this container.
  66:    *
  67:    * @param except the exception to insert.
  68:    */
  69:   public abstract void exception(Exception except);
  70: }