org.opencms.cache.I_CmsLruCacheObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library 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 library 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.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.cache;

/**
 * Defines the methods which an object being cached by CmsFlexLruCache must implement.
 *
 * CmsFlexLruCache is organized as a double linked list, that's why objects implementing this interface
 * need getters/setter for the next/previous nodes in the list of all cached objects.

 *
 * @see CmsLruCache
 *
 * @since 6.0.0
 */
public interface I_CmsLruCacheObject {

    /**
     * Set the next object in the double linked list of all cached objects.

     *
     * @param theNextObject the next object
     */
    void setNextLruObject(I_CmsLruCacheObject theNextObject);

    /**
     * Returns the next object in the double linked list of all cached objects.

     *
     * @return the next object in the double linked list of all cached objects
     */
    I_CmsLruCacheObject getNextLruObject();

    /**
     * Set the previous object in the double linked list of all cached objects.

     *
     * @param thePreviousObject the previous object
     */
    void setPreviousLruObject(I_CmsLruCacheObject thePreviousObject);

    /**
     * Returns the previous object in the double linked list of all cached objects.

     *
     * @return the previous object in the double linked list of all cached objects
     */
    I_CmsLruCacheObject getPreviousLruObject();

    /**
     * Invoked after an object was added to the cache.

     */
    void addToLruCache();

    /**
     * Invoked after the object was removed to the cache.

     */
    void removeFromLruCache();

    /**
     * Returns the cache costs of this object, as for example it's byte size.

     *
     * @return the cache costs of this object
     */
    int getLruCacheCosts();

    /**
     * Returns the Object value.
     *
     * @return the Object value
     */
    Object getValue();
}