001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.rest.server.arg;
018
019import static org.apache.juneau.commons.utils.Shorts.*;
020
021import org.apache.juneau.commons.reflect.*;
022import org.apache.juneau.http.response.*;
023
024/**
025 * General exception due to a malformed Java parameter.
026 *
027 * <h5 class='section'>See Also:</h5><ul>
028 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JavaMethodParameters">Java Method Parameters</a>
029 * </ul>
030 *
031 * @serial exclude
032 */
033@SuppressWarnings({
034   "java:S110" // Inheritance depth acceptable for ArgException hierarchy
035})
036public class ArgException extends InternalServerError {
037   private static final long serialVersionUID = 1L;
038
039   /**
040    * Constructor.
041    *
042    * @param pi The parameter with the issue. Must not be <jk>null</jk>.
043    * @param msg The message.
044    * @param args The message args.
045    */
046   public ArgException(ParameterInfo pi, String msg, Object...args) {
047      super(f(msg, args) + " on parameter " + pi.getIndex() + " of method " + pi.getMethod().getNameFull() + ".");
048   }
049}