1 /*
   2  * Copyright (c) 1995, 2006, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package org.omg.CORBA;
  27 
  28 /**
  29  * This exception is raised if communication is lost while an operation
  30  * is in progress, after the request was sent by the client, but before
  31  * the reply from the server has been returned to the client.<P>
  32  * It contains a minor code, which gives more detailed information about
  33  * what caused the exception, and a completion status. It may also contain
  34  * a string describing the exception.
  35  * <P>
  36  * See the section <A href="../../../../technotes/guides/idl/jidlExceptions.html#minorcodemeanings">meaning
  37  * of minor codes</A> to see the minor codes for this exception.
  38  *
  39  * @see <A href="../../../../technotes/guides/idl/jidlExceptions.html#minorcodemeanings">meaning of
  40  * minor codes</A>
  41  * @since       JDK1.2
  42  */
  43 
  44 public final class COMM_FAILURE extends SystemException {
  45 
  46     /**
  47      * Constructs a <code>COMM_FAILURE</code> exception with
  48      * a default minor code of 0 and a completion state of COMPLETED_NO.
  49      */
  50     public COMM_FAILURE() {
  51         this("");
  52     }
  53 
  54     /**
  55      * Constructs a <code>COMM_FAILURE</code> exception with the specified detail
  56      * message, a minor code of 0, and a completion state of COMPLETED_NO.
  57      *
  58      * @param s the <code>String</code> containing a detail message describing
  59      *          this exception
  60      */
  61     public COMM_FAILURE(String s) {
  62         this(s, 0, CompletionStatus.COMPLETED_NO);
  63     }
  64 
  65     /**
  66      * Constructs a <code>COMM_FAILURE</code> exception with the specified
  67      * minor code and completion status.
  68      * @param minor the minor code
  69      * @param completed the completion status, which must be one of
  70      *                  <code>COMPLETED_YES</code>, <code>COMPLETED_NO</code>, or
  71      *                  <code>COMPLETED_MAYBE</code>.
  72      */
  73     public COMM_FAILURE(int minor, CompletionStatus completed) {
  74         this("", minor, completed);
  75     }
  76 
  77     /**
  78      * Constructs a <code>COMM_FAILURE</code> exception with the specified detail
  79      * message, minor code, and completion status.
  80      * A detail message is a String that describes this particular exception.
  81      * @param s the String containing a detail message
  82      * @param minor the minor code
  83      * @param completed the completion status, which must be one of
  84      *                  <code>COMPLETED_YES</code>, <code>COMPLETED_NO</code>, or
  85      *                  <code>COMPLETED_MAYBE</code>.
  86      */
  87     public COMM_FAILURE(String s, int minor, CompletionStatus completed) {
  88         super(s, minor, completed);
  89     }
  90 }