com.googlecode.ehcache.annotations.config.ExactCacheNameMatcherImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ehcache-spring-annotations Show documentation

Provides a simple model for integrating Ehcache in a Spring project via annotations.

There is a newer version: 1.2.0

Show newest version

/**
 * Copyright 2010 Nicholas Blair, Eric Dalquist
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * 
 */
package com.googlecode.ehcache.annotations.config;

import com.googlecode.ehcache.annotations.impl.CacheNameMatcher;
import com.googlecode.ehcache.annotations.impl.Vote;

/**
 * Implementation of {@link CacheNameMatcher} for
 * matching a specific name.
 * 
 * @author Nicholas Blair
 * @version $Id: ExactCacheNameMatcherImpl.java 565 2010-07-06 15:24:34Z [email protected] $
 */
public class ExactCacheNameMatcherImpl implements CacheNameMatcher {

    private final String name;
    /**
     * 
     * @param name
     * @throws IllegalArgumentException if the name argument is null
     */
    public ExactCacheNameMatcherImpl(String name) {
        if(null == name) {
            throw new IllegalArgumentException("name cannot be null");
        }
        this.name = name;
    }
    /**
     * Returns {@link Vote#YEA} if the name field {@link String#equals(Object)} the cacheName argument,
     * {@link Vote#ABSTAIN} otherwise.
     * 
     * @see String#equals(Object)
     * @see com.googlecode.ehcache.annotations.impl.CacheNameMatcher#matches(java.lang.String)
     */
    public Vote matches(String cacheName) {
        boolean result = this.name.equals(cacheName);
        return result ? Vote.YEA : Vote.ABSTAIN;
    }
    
    /**
     * @return the name this matcher is configured to match
     */
    public String getName() {
        return name;
    }

}