ConfigurationExpiryTimeCache.java

/**************************************************************************************
 * Copyright (C) 2008 EsperTech, Inc. All rights reserved.                            *
 * http://esper.codehaus.org                                                          *
 * http://www.espertech.com                                                           *
 * ---------------------------------------------------------------------------------- *
 * The software in this package is published under the terms of the GPL license       *
 * a copy of which has been included with this distribution in the license.txt file.  *
 **************************************************************************************/
package com.espertech.esper.client;

import java.io.Serializable;

/**
 * Expiring cache settings.
 */
public class ConfigurationExpiryTimeCache implements ConfigurationDataCache, Serializable
{
    private ConfigurationCacheReferenceType cacheReferenceType;
    private double maxAgeSeconds;
    private double purgeIntervalSeconds;
    private static final long serialVersionUID = 1213687721462970573L;

    /**
     * Ctor.
     * @param maxAgeSeconds is the maximum age in seconds
     * @param purgeIntervalSeconds is the purge interval
     * @param cacheReferenceType the reference type may allow garbage collection to remove entries from
     * cache unless HARD reference type indicates otherwise
     */
    public ConfigurationExpiryTimeCache(double maxAgeSeconds, double purgeIntervalSeconds, ConfigurationCacheReferenceType cacheReferenceType)
    {
        this.maxAgeSeconds = maxAgeSeconds;
        this.purgeIntervalSeconds = purgeIntervalSeconds;
        this.cacheReferenceType = cacheReferenceType;
    }

    /**
     * Returns the maximum age in seconds.
     * @return number of seconds
     */
    public double getMaxAgeSeconds()
    {
        return maxAgeSeconds;
    }

    /**
     * Returns the purge interval length.
     * @return purge interval in seconds
     */
    public double getPurgeIntervalSeconds()
    {
        return purgeIntervalSeconds;
    }

    /**
     * Returns the enumeration whether hard, soft or weak reference type are used
     * to control whether the garbage collection can remove entries from cache.
     * @return reference type
     */
    public ConfigurationCacheReferenceType getCacheReferenceType()
    {
        return cacheReferenceType;
    }

    public String toString()
    {
        return "ExpiryTimeCacheDesc maxAgeSeconds=" + maxAgeSeconds + " purgeIntervalSeconds=" + purgeIntervalSeconds;
    }
}