View Javadoc
1   /*
2    * Copyright (c) 2003, 2005, 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 a character with an invalid Unicode code
30   * point as defined by {@link Character#isValidCodePoint} is passed to the
31   * {@link Formatter}.
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 IllegalFormatCodePointException extends IllegalFormatException {
40  
41      private static final long serialVersionUID = 19080630L;
42  
43      private int c;
44  
45      /**
46       * Constructs an instance of this class with the specified illegal code
47       * point as defined by {@link Character#isValidCodePoint}.
48       *
49       * @param  c
50       *         The illegal Unicode code point
51       */
52      public IllegalFormatCodePointException(int c) {
53          this.c = c;
54      }
55  
56      /**
57       * Returns the illegal code point as defined by {@link
58       * Character#isValidCodePoint}.
59       *
60       * @return  The illegal Unicode code point
61       */
62      public int getCodePoint() {
63          return c;
64      }
65  
66      public String getMessage() {
67          return String.format("Code point = %#x", c);
68      }
69  }