001/*
002 * Copyright 2002-2019 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.aop;
018
019/**
020 * Filter that restricts matching of a pointcut or introduction to
021 * a given set of target classes.
022 *
023 * <p>Can be used as part of a {@link Pointcut} or for the entire
024 * targeting of an {@link IntroductionAdvisor}.
025 *
026 * <p>Concrete implementations of this interface typically should provide proper
027 * implementations of {@link Object#equals(Object)} and {@link Object#hashCode()}
028 * in order to allow the filter to be used in caching scenarios &mdash; for
029 * example, in proxies generated by CGLIB.
030 *
031 * @author Rod Johnson
032 * @see Pointcut
033 * @see MethodMatcher
034 */
035@FunctionalInterface
036public interface ClassFilter {
037
038        /**
039         * Should the pointcut apply to the given interface or target class?
040         * @param clazz the candidate target class
041         * @return whether the advice should apply to the given target class
042         */
043        boolean matches(Class<?> clazz);
044
045
046        /**
047         * Canonical instance of a ClassFilter that matches all classes.
048         */
049        ClassFilter TRUE = TrueClassFilter.INSTANCE;
050
051}