001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements. See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership. The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License. You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied. See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.commons.weaver.model;
020
021import java.lang.annotation.Annotation;
022import java.lang.annotation.RetentionPolicy; //NOPMD used in javadoc
023import java.lang.reflect.AnnotatedElement;
024
025/**
026 * Interface defining a means of iterating over a particular type of
027 * {@link AnnotatedElement} as well as filtering by annotation type (including
028 * annotations with {@link RetentionPolicy#CLASS} retention in addition to those
029 * with {@link RetentionPolicy#RUNTIME} retention.
030 * @param <T> element type
031 */
032public interface AnnotatedElements<T extends AnnotatedElement> extends Iterable<T> {
033    /**
034     * Filter by annotation type.
035     * @param annotationType filter
036     * @return {@link AnnotatedElements}, narrowed
037     */
038    AnnotatedElements<T> with(Class<? extends Annotation> annotationType);
039}