com.google.code.ssm.aop.support.CacheKeyMethodStore Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2008-2015 Nelson Carpentier, Jakub Białek
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 */

package com.google.code.ssm.aop.support;

import java.lang.reflect.Method;

import com.google.code.ssm.api.CacheKeyMethod;

/**
 * Stores methods used to calculate part of the cache key for given class.
 * 
 * @author Nelson Carpentier
 * @author Jakub Białek
 * 
 */
public interface CacheKeyMethodStore {

    /**
     * Gets method used to calculate cache key on given class.
     * 
     * @param keyClass
     * @return method used to calculate cache key
     * @throws NoSuchMethodException
     *             if class doesn't contain method annotated by {@link CacheKeyMethod} or toString() method
     */
    Method getKeyMethod(final Class keyClass) throws NoSuchMethodException;

}