View Javadoc
1   /*
2    * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package java.util;
27  
28  /**
29   * Unchecked exception thrown when there is a format specifier which does not
30   * have a corresponding argument or if an argument index refers to an argument
31   * that does not exist.
32   *
33   * <p> Unless otherwise specified, passing a <tt>null</tt> argument to any
34   * method or constructor in this class will cause a {@link
35   * NullPointerException} to be thrown.
36   *
37   * @since 1.5
38   */
39  public class MissingFormatArgumentException extends IllegalFormatException {
40  
41      private static final long serialVersionUID = 19190115L;
42  
43      private String s;
44  
45      /**
46       * Constructs an instance of this class with the unmatched format
47       * specifier.
48       *
49       * @param  s
50       *         Format specifier which does not have a corresponding argument
51       */
52      public MissingFormatArgumentException(String s) {
53          if (s == null)
54              throw new NullPointerException();
55          this.s = s;
56      }
57  
58      /**
59       * Returns the unmatched format specifier.
60       *
61       * @return  The unmatched format specifier
62       */
63      public String getFormatSpecifier() {
64          return s;
65      }
66  
67      public String getMessage() {
68          return "Format specifier '" + s + "'";
69      }
70  }