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 static org.apache.juneau.commons.utils.Utils.*;
020
021import java.lang.annotation.*;
022import java.util.*;
023
024import org.apache.juneau.*;
025import org.apache.juneau.commons.reflect.*;
026
027/**
028 * Defines an invalid usage of an annotation.
029 *
030 *
031 * @serial exclude
032 */
033public class InvalidAnnotationException extends BasicRuntimeException {
034
035   private static final long serialVersionUID = 1L;
036
037   /**
038    * Throws an {@link InvalidAnnotationException} if the specified method contains any of the specified annotations.
039    *
040    * @param onMethod The method to check.
041    * @param types The annotations to check for.
042    * @throws InvalidAnnotationException Annotation was used in an invalid location.
043    */
044   @SafeVarargs
045   public static void assertNoInvalidAnnotations(MethodInfo onMethod, Class<? extends Annotation>...types) throws InvalidAnnotationException {
046      // @formatter:off
047      Arrays.stream(types)
048         .map(t -> onMethod.getAnnotations(t).findFirst().map(AnnotationInfo::inner).orElse(null))
049         .filter(Objects::nonNull)
050         .findFirst()
051         .ifPresent(a -> {
052            throw new InvalidAnnotationException("@{0} annotation cannot be used in a @{1} bean.  Method=''{2}''", cns(a), cns(onMethod.getDeclaringClass()), onMethod);
053         });
054      // @formatter:on
055   }
056
057   /**
058    * Constructor.
059    *
060    * @param message Message.
061    * @param args Arguments.
062    */
063   public InvalidAnnotationException(String message, Object...args) {
064      super(message, args);
065   }
066
067   @Override /* Overridden from BasicRuntimeException */
068   public InvalidAnnotationException setMessage(String message, Object...args) {
069      super.setMessage(message, args);
070      return this;
071   }
072}