001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.annotation;
014
015import java.lang.annotation.*;
016
017import org.apache.juneau.*;
018import org.apache.juneau.reflect.*;
019
020/**
021 * Defines an invalid usage of an annotation.
022 *
023 * <h5 class='section'>See Also:</h5><ul>
024 * </ul>
025 *
026 * @serial exclude
027 */
028public class InvalidAnnotationException extends BasicRuntimeException {
029
030   private static final long serialVersionUID = 1L;
031
032   /**
033    * Constructor.
034    *
035    * @param message Message.
036    * @param args Arguments.
037    */
038   public InvalidAnnotationException(String message, Object...args) {
039      super(message, args);
040   }
041
042   /**
043    * Throws an {@link InvalidAnnotationException} if the specified method contains any of the specified annotations.
044    *
045    * @param onMethod The method to check.
046    * @param types The annotations to check for.
047    * @throws InvalidAnnotationException Annotation was used in an invalid location.
048    */
049   @SafeVarargs
050   public static void assertNoInvalidAnnotations(MethodInfo onMethod, Class<? extends Annotation>...types) throws InvalidAnnotationException {
051      Annotation a = onMethod.getAnyAnnotation(types);
052      if (a != null)
053         throw new InvalidAnnotationException("@{0} annotation cannot be used in a @{1} bean.  Method=''{2}''", a.getClass().getSimpleName(), onMethod.getDeclaringClass().getSimpleName(), onMethod);
054   }
055}