com.maxifier.mxcache.ehcache.UseEhcache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mxcache-ehcache-integration Show documentation

A set of custom caching strategies for EhCache framework

There is a newer version: 2.6.9

Show newest version

/*
 * Copyright (c) 2008-2014 Maxifier Ltd. All Rights Reserved.
 */
package com.maxifier.mxcache.ehcache;

import com.maxifier.mxcache.PublicAPI;

import java.lang.annotation.*;

/**
 * UseEhcache - this annotation makes MxCache use Ehcache strategy for methods annotated with it.
 * Don't forget to put @Cached annotation among with it.
 * Name for cache is taken from @Cached annotation 'name' attribute.
 * By default the configuration of Ehcache is read from ehcache.xml from META-INF, though you can override it
 * with attribute of this annotation.
 *
 * @author Alexander Kochurov ([email protected])
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface UseEhcache {
    /**
     * @return ehcache XML config URL, use "classpath://" to refer to classpath resources (the classloader of cache
     *    owner class is used to obtain configuration in this case).
     */
    @PublicAPI
    String configURL() default "classpath://META-INF/ehcache.xml";
}