1 /* 2 * Copyright (c) 2020, 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 the argument index is not within the valid 30 * range of supported argument index values. If an index value isn't 31 * representable by an {@code int} type, then the value 32 * {@code Integer.MIN_VALUE} will be used in the exception. 33 * 34 * @since 16 35 */ 36 class IllegalFormatArgumentIndexException extends IllegalFormatException { 37 38 @java.io.Serial 39 private static final long serialVersionUID = 4191767811181838112L; 40 41 private final int illegalIndex; 42 43 /** 44 * Constructs an instance of this class with the specified argument index 45 * @param index The value of a corresponding illegal argument index. 46 */ IllegalFormatArgumentIndexException(int index)47 IllegalFormatArgumentIndexException(int index) { 48 illegalIndex = index; 49 } 50 51 /** 52 * Gets the value of the illegal index. 53 * Returns {@code Integer.MIN_VALUE} if the illegal index is not 54 * representable by an {@code int}. 55 * @return the illegal index value 56 */ getIndex()57 int getIndex() { 58 return illegalIndex; 59 } 60 61 @Override getMessage()62 public String getMessage() { 63 int index = getIndex(); 64 65 if (index == Integer.MIN_VALUE) { 66 return "Format argument index: (not representable as int)"; 67 } 68 69 return String.format("Illegal format argument index = %d", getIndex()); 70 } 71 72 } 73