001    /* PolicyError.java --
002       Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.CORBA;
040    
041    import org.omg.CORBA.portable.IDLEntity;
042    
043    import java.io.Serializable;
044    
045    /**
046     * The exception is thrown when a policy error occurs.
047     * A PolicyError exception may include one of the following error reason codes:
048     * {@link BAD_POLICY}, {@link BAD_POLICY_TYPE},
049     * {@link BAD_POLICY_VALUE}, {@link UNSUPPORTED_POLICY},
050     * {@link UNSUPPORTED_POLICY_VALUE}.
051     *
052     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
053     */
054    public final class PolicyError
055      extends UserException
056      implements IDLEntity, Serializable
057    {
058      /**
059       * Holds the exception reason code, one of
060       * {@link BAD_POLICY}, {@link BAD_POLICY_TYPE},
061       * {@link BAD_POLICY_VALUE}, {@link UNSUPPORTED_POLICY},
062       * {@link UNSUPPORTED_POLICY_VALUE}.
063      */
064      public short reason;
065    
066      /**
067       * Use serialVersionUID (v1.4) for interoperability.
068       */
069      private static final long serialVersionUID = -9196809779974700103L;
070    
071      /**
072       * Constructs an uninitialised instance of the policy error.
073       */
074      public PolicyError()
075      {
076      }
077    
078      /**
079       * Constructs the policy error with the given reason code.
080       * @param a_reason a reason code, one of
081       * {@link BAD_POLICY}, {@link BAD_POLICY_TYPE},
082       * {@link BAD_POLICY_VALUE}, {@link UNSUPPORTED_POLICY},
083       * {@link UNSUPPORTED_POLICY_VALUE}.
084       */
085      public PolicyError(short a_reason)
086      {
087        reason = a_reason;
088      }
089    
090      /**
091       * Constructs the policy error with the given reason code and the
092       * detailed message.
093       * @param a_details the detailed message.
094       * @param a_reason a reason code, one of
095       * {@link BAD_POLICY}, {@link BAD_POLICY_TYPE},
096       * {@link BAD_POLICY_VALUE}, {@link UNSUPPORTED_POLICY},
097       * {@link UNSUPPORTED_POLICY_VALUE}.
098       */
099      public PolicyError(String a_details, short a_reason)
100      {
101        super(a_details);
102        reason = a_reason;
103      }
104    }