Source for java.util.IllegalFormatConversionException

   1: /* IllegalFormatConversionException.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 type of an argument supplied to the
  43:  * {@link Formatter#format()} method of a {@link Formatter}
  44:  * does not match the conversion character specified for it.
  45:  *
  46:  * @author Tom Tromey (tromey@redhat.com)
  47:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  48:  * @since 1.5
  49:  */
  50: public class IllegalFormatConversionException
  51:   extends IllegalFormatException
  52: {
  53:   private static final long serialVersionUID = 17000126L;
  54: 
  55:   /**
  56:    * The conversion character which doesn't match
  57:    * the type of the argument.
  58:    *
  59:    * @serial the conversion character.
  60:    */
  61:   // Note: name fixed by serialization.
  62:   char c;
  63: 
  64:   /**
  65:    * The type of the mismatching argument.
  66:    *
  67:    * @serial the mismatching argument type.
  68:    */
  69:   // Note: name fixed by serialization.
  70:   Class<?> arg;
  71: 
  72:   /**
  73:    * Constructs a new <code>IllegalFormatConversionException</code>
  74:    * which specifies that the argument of type <code>arg</code> does
  75:    * not match the conversion character, <code>c</code>.
  76:    *
  77:    * @param c the conversion character.
  78:    * @param arg the type which doesn't match the conversion character.
  79:    * @throws NullPointerException if <code>arg</code> is null.
  80:    */
  81:   public IllegalFormatConversionException(char c, Class<?> arg)
  82:   {
  83:     super("The type, " + arg + ", is invalid for the conversion character, " +
  84:           c + ".");
  85:     if (arg == null)
  86:       throw new NullPointerException("The supplied type was null.");
  87:     this.c = c;
  88:     this.arg = arg;
  89:   }
  90: 
  91:   /**
  92:    * Returns the conversion character.
  93:    *
  94:    * @return the conversion character.
  95:    */
  96:   public char getConversion()
  97:   {
  98:     return c;
  99:   }
 100: 
 101:   /**
 102:    * Returns the type of the mismatched argument.
 103:    *
 104:    * @return the type of the mismatched argument.
 105:    */
 106:   public Class<?> getArgumentClass()
 107:   {
 108:     return arg;
 109:   }
 110: }