Source for org.omg.PortableServer.POAPackage.InvalidPolicy

   1: /* InvalidPolicy.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.PortableServer.POAPackage;
  40: 
  41: import org.omg.CORBA.UserException;
  42: import org.omg.CORBA.portable.IDLEntity;
  43: 
  44: import java.io.Serializable;
  45: 
  46: /**
  47:  * Raised if any of the policy objects specified is not supported by this
  48:  * ORB implementation, if conflicting policy objects are specified,
  49:  * or if any of the specified policy objects require prior administrative
  50:  * action that has not been performed.
  51:  *
  52:  *
  53:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  54:  */
  55: public final class InvalidPolicy
  56:   extends UserException
  57:   implements IDLEntity, Serializable
  58: {
  59:   /**
  60:    * Use serialVersionUID (v1.4) for interoperability.
  61:    */
  62:   private static final long serialVersionUID = 3204212102282117205L;
  63: 
  64:   /**
  65:    * The index in the policies parameter value of the first offending
  66:    * policy object.
  67:    */
  68:   public short index;
  69: 
  70:   /**
  71:    * Create InvalidPolicy with no explaining
  72:    * message and leaving {@link #index} with default 0 value.
  73:    */
  74:   public InvalidPolicy()
  75:   {
  76:   }
  77: 
  78:   /**
  79:    * Create the InvalidPolicy with explaining
  80:    * message and initialisintg {@link #index} to the passed value.
  81:    *
  82:    * @param why a string, explaining, why this exception has been thrown.
  83:    * @param a_index a value for index.
  84:    */
  85:   public InvalidPolicy(String why, short a_index)
  86:   {
  87:     super(why);
  88:     this.index = a_index;
  89:   }
  90: 
  91:   /**
  92:    * Create the InvalidPolicy without explaining
  93:    * message and initialisintg {@link #index} to the passed value.
  94:    *
  95:    * @param a_index a value for index.
  96:    */
  97:   public InvalidPolicy(short a_index)
  98:   {
  99:     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:   }