Source for java.util.IllegalFormatFlagsException

   1: /* IllegalFormatFlagsException.java
   2:    Copyright (C) 2005  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 java.util;
  40: 
  41: /**
  42:  * Thrown when the flags supplied to the {@link Formatter#format()}
  43:  * method of a {@link Formatter} form an illegal combination.
  44:  *
  45:  * @author Tom Tromey (tromey@redhat.com)
  46:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  47:  * @since 1.5
  48:  */
  49: public class IllegalFormatFlagsException
  50:   extends IllegalFormatException
  51: {
  52:   private static final long serialVersionUID = 790824L;
  53: 
  54:   /**
  55:    * The set of flags which forms an illegal combination.
  56:    *
  57:    * @serial the illegal set of flags.
  58:    */
  59:   // Note: name fixed by serialization.
  60:   private String flags;
  61: 
  62:   /**
  63:    * Constructs a new <code>IllegalFormatFlagsException</code>
  64:    * for the specified flags.
  65:    *
  66:    * @param flags the illegal set of flags.
  67:    * @throws NullPointerException if <code>flags</code> is null.
  68:    */
  69:   public IllegalFormatFlagsException(String flags)
  70:   {
  71:     super("An illegal set of flags, " + flags + ", was supplied.");
  72:     if (flags == null)
  73:       throw new NullPointerException("The supplied flags are null.");
  74:     this.flags = flags;
  75:   }
  76: 
  77:   /**
  78:    * Returns the illegal flags.
  79:    *
  80:    * @return the illegal flags.
  81:    */
  82:   public String getFlags()
  83:   {
  84:     return flags;
  85:   }
  86: }