001/* InvalidPolicy.java --
002   Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.PortableServer.POAPackage;
040
041import org.omg.CORBA.UserException;
042import org.omg.CORBA.portable.IDLEntity;
043
044import java.io.Serializable;
045
046/**
047 * Raised if any of the policy objects specified is not supported by this
048 * ORB implementation, if conflicting policy objects are specified,
049 * or if any of the specified policy objects require prior administrative
050 * action that has not been performed.
051 *
052 *
053 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
054 */
055public final class InvalidPolicy
056  extends UserException
057  implements IDLEntity, Serializable
058{
059  /**
060   * Use serialVersionUID (v1.4) for interoperability.
061   */
062  private static final long serialVersionUID = 3204212102282117205L;
063
064  /**
065   * The index in the policies parameter value of the first offending
066   * policy object.
067   */
068  public short index;
069
070  /**
071   * Create InvalidPolicy with no explaining
072   * message and leaving {@link #index} with default 0 value.
073   */
074  public InvalidPolicy()
075  {
076  }
077
078  /**
079   * Create the InvalidPolicy with explaining
080   * message and initialisintg {@link #index} to the passed value.
081   *
082   * @param why a string, explaining, why this exception has been thrown.
083   * @param a_index a value for index.
084   */
085  public InvalidPolicy(String why, short a_index)
086  {
087    super(why);
088    this.index = a_index;
089  }
090
091  /**
092   * Create the InvalidPolicy without explaining
093   * message and initialisintg {@link #index} to the passed value.
094   *
095   * @param a_index a value for index.
096   */
097  public InvalidPolicy(short a_index)
098  {
099    this.index = a_index;
100  }
101
102  /**
103   * Adds {@link #index} to the super.getMessage().
104   */
105  public String getMessage()
106  {
107    return super.getMessage() + " at index " + index;
108  }
109}