001/*
002 * Copyright 2002-2018 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.cache.jcache.interceptor;
018
019import java.lang.reflect.Method;
020
021import org.springframework.lang.Nullable;
022
023/**
024 * Interface used by {@link JCacheInterceptor}. Implementations know how to source
025 * cache operation attributes from standard JSR-107 annotations.
026 *
027 * @author Stephane Nicoll
028 * @since 4.1
029 * @see org.springframework.cache.interceptor.CacheOperationSource
030 */
031public interface JCacheOperationSource {
032
033        /**
034         * Return the cache operations for this method, or {@code null}
035         * if the method contains no <em>JSR-107</em> related metadata.
036         * @param method the method to introspect
037         * @param targetClass the target class (may be {@code null}, in which case
038         * the declaring class of the method must be used)
039         * @return the cache operation for this method, or {@code null} if none found
040         */
041        @Nullable
042        JCacheOperation<?> getCacheOperation(Method method, @Nullable Class<?> targetClass);
043
044}