001/*
002 * Copyright 2002-2013 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.interceptor;
018
019import java.lang.reflect.Method;
020
021/**
022 * Cache key generator. Used for creating a key based on the given method
023 * (used as context) and its parameters.
024 *
025 * @author Costin Leau
026 * @author Chris Beams
027 * @author Phillip Webb
028 * @since 3.1
029 */
030public interface KeyGenerator {
031
032        /**
033         * Generate a key for the given method and its parameters.
034         * @param target the target instance
035         * @param method the method being called
036         * @param params the method parameters (with any var-args expanded)
037         * @return a generated key
038         */
039        Object generate(Object target, Method method, Object... params);
040
041}