org.xwiki.cache.CacheEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-cache-api Show documentation

XWiki Commons - Cache - API

The newest version!

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.cache;

/**
 * Represents a cache entry with it's key, value, etc.
 * 
 * @param  the class of the data stored in the cache.
 * @version $Id: 32164bb81d9fda54612800c062ddd83210978988 $
 */
public interface CacheEntry
{
    /**
     * @return the cache where this entry is stored.
     */
    Cache getCache();

    /**
     * @return the associated key used to access the value in the cache.
     */
    String getKey();

    /**
     * @return the value of this cache entry.
     */
    T getValue();
}