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.annotation;
018
019import java.lang.annotation.*;
020
021import org.apache.juneau.*;
022import org.apache.juneau.reflect.*;
023
024/**
025 * Defines an invalid usage of an annotation.
026 *
027 * <h5 class='section'>See Also:</h5><ul>
028 * </ul>
029 *
030 * @serial exclude
031 */
032public class InvalidAnnotationException extends BasicRuntimeException {
033
034   private static final long serialVersionUID = 1L;
035
036   /**
037    * Constructor.
038    *
039    * @param message Message.
040    * @param args Arguments.
041    */
042   public InvalidAnnotationException(String message, Object...args) {
043      super(message, args);
044   }
045
046   /**
047    * Throws an {@link InvalidAnnotationException} if the specified method contains any of the specified annotations.
048    *
049    * @param onMethod The method to check.
050    * @param types The annotations to check for.
051    * @throws InvalidAnnotationException Annotation was used in an invalid location.
052    */
053   @SafeVarargs
054   public static void assertNoInvalidAnnotations(MethodInfo onMethod, Class<? extends Annotation>...types) throws InvalidAnnotationException {
055      Annotation a = onMethod.getAnyAnnotation(types);
056      if (a != null)
057         throw new InvalidAnnotationException("@{0} annotation cannot be used in a @{1} bean.  Method=''{2}''", a.getClass().getSimpleName(), onMethod.getDeclaringClass().getSimpleName(), onMethod);
058   }
059}