gcc/libjava/classpath/java/util/MissingFormatArgumentException.java

/* MissingFormatArgumentException.java
   Copyright (C) 2005  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.util;

/** 
 * Thrown when the a format specification for a {@link Formatter}
 * refers to an argument that is non-existent, or an argument index
 * references a non-existent argument.
 *
 * @author Tom Tromey (tromey@redhat.com)
 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
 * @since 1.5 
 */
public class MissingFormatArgumentException 
  extends IllegalFormatException
{
  private static final long serialVersionUID = 19190115L;

  /**
   * The format specification which contains the
   * unmatched argument.
   *
   * @serial the format specification.
   */
  // Note: name fixed by serialization.
  private String s;

  /**
   * Constructs a new <code>MissingFormatArgumentException</code>
   * for a format specification, <code>s</code>, which refers
   * to a non-existent argument.
   *
   * @param s the format specification.
   * @throws NullPointerException if <code>s</code> is null.
   */
  public MissingFormatArgumentException(String s)
  {
    super("The specification, " + s + 
	  ", refers to a non-existent argument.");
    if (s == null)
      throw new NullPointerException("The specification is null.");
    this.s = s;
  }

  /**
   * Returns the format specification.
   *
   * @return the format specification.
   */
  public String getFormatSpecifier()
  {
    return s;
  }
}