libjava/classpath/org/omg/CORBA/PolicyError.java

   1 /* PolicyError.java --
   2    Copyright (C) 2005, 2006 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 import org.omg.CORBA.portable.IDLEntity;
  42
  43 import java.io.Serializable;
  44
  45 /**
  46  * The exception is thrown when a policy error occurs.
  47  * A PolicyError exception may include one of the following error reason codes:
  48  * {@link BAD_POLICY}, {@link BAD_POLICY_TYPE},
  49  * {@link BAD_POLICY_VALUE}, {@link UNSUPPORTED_POLICY},
  50  * {@link UNSUPPORTED_POLICY_VALUE}.
  51  *
  52  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  53  */
  54 public final class PolicyError
  55   extends UserException
  56   implements IDLEntity, Serializable
  57 {
  58   /**
  59    * Holds the exception reason code, one of
  60    * {@link BAD_POLICY}, {@link BAD_POLICY_TYPE},
  61    * {@link BAD_POLICY_VALUE}, {@link UNSUPPORTED_POLICY},
  62    * {@link UNSUPPORTED_POLICY_VALUE}.
  63   */
  64   public short reason;
  65
  66   /**
  67    * Use serialVersionUID (v1.4) for interoperability.
  68    */
  69   private static final long serialVersionUID = -9196809779974700103L;
  70
  71   /**
  72    * Constructs an uninitialised instance of the policy error.
  73    */
  74   public PolicyError()
  75   {
  76   }
  77
  78   /**
  79    * Constructs the policy error with the given reason code.
  80    * @param a_reason a reason code, one of
  81    * {@link BAD_POLICY}, {@link BAD_POLICY_TYPE},
  82    * {@link BAD_POLICY_VALUE}, {@link UNSUPPORTED_POLICY},
  83    * {@link UNSUPPORTED_POLICY_VALUE}.
  84    */
  85   public PolicyError(short a_reason)
  86   {
  87     reason = a_reason;
  88   }
  89
  90   /**
  91    * Constructs the policy error with the given reason code and the
  92    * detailed message.
  93    * @param a_details the detailed message.
  94    * @param a_reason a reason code, one of
  95    * {@link BAD_POLICY}, {@link BAD_POLICY_TYPE},
  96    * {@link BAD_POLICY_VALUE}, {@link UNSUPPORTED_POLICY},
  97    * {@link UNSUPPORTED_POLICY_VALUE}.
  98    */
  99   public PolicyError(String a_details, short a_reason)
 100   {
 101     super(a_details);
 102     reason = a_reason;
 103   }
 104 }