001/* IllegalFormatConversionException.java
002   Copyright (C) 2005  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 java.util;
040
041/**
042 * Thrown when the type of an argument supplied to the
043 * {@link Formatter#format()} method of a {@link Formatter}
044 * does not match the conversion character specified for it.
045 *
046 * @author Tom Tromey (tromey@redhat.com)
047 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
048 * @since 1.5
049 */
050public class IllegalFormatConversionException
051  extends IllegalFormatException
052{
053  private static final long serialVersionUID = 17000126L;
054
055  /**
056   * The conversion character which doesn't match
057   * the type of the argument.
058   *
059   * @serial the conversion character.
060   */
061  // Note: name fixed by serialization.
062  char c;
063
064  /**
065   * The type of the mismatching argument.
066   *
067   * @serial the mismatching argument type.
068   */
069  // Note: name fixed by serialization.
070  Class<?> arg;
071
072  /**
073   * Constructs a new <code>IllegalFormatConversionException</code>
074   * which specifies that the argument of type <code>arg</code> does
075   * not match the conversion character, <code>c</code>.
076   *
077   * @param c the conversion character.
078   * @param arg the type which doesn't match the conversion character.
079   * @throws NullPointerException if <code>arg</code> is null.
080   */
081  public IllegalFormatConversionException(char c, Class<?> arg)
082  {
083    super("The type, " + arg + ", is invalid for the conversion character, " +
084          c + ".");
085    if (arg == null)
086      throw new NullPointerException("The supplied type was null.");
087    this.c = c;
088    this.arg = arg;
089  }
090
091  /**
092   * Returns the conversion character.
093   *
094   * @return the conversion character.
095   */
096  public char getConversion()
097  {
098    return c;
099  }
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}