oracle.toplink.essentials.descriptors.invalidation.NoExpiryCacheInvalidationPolicy Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* // Copyright (c) 1998, 2007, Oracle. All rights reserved.
*
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package oracle.toplink.essentials.descriptors.invalidation;
import oracle.toplink.essentials.internal.identitymaps.CacheKey;
import oracle.toplink.essentials.descriptors.invalidation.CacheInvalidationPolicy;
/**
* PUBLIC:
* A cache invalidation policy in which no objects will expire. The only way for objects
* to become invalid in the cache is for them to be explicitly set to invalid through
* method calls on the IdentityMapAccessor. This is the default cache invalidation policy.
* @see CacheInvalidationPolicy
* @see oracle.toplink.essentials.sessions.IdentityMapAccessor
*/
public class NoExpiryCacheInvalidationPolicy extends CacheInvalidationPolicy {
/**
* INTERNAL:
* Since this policy implements no expiry, this will always return NO_EXPIRY
*/
public long getExpiryTimeInMillis(CacheKey key) {
return NO_EXPIRY;
}
/**
* INTERNAL:
* Return the remaining life of this object
* Override the default implementation.
*/
public long getRemainingValidTime(CacheKey key) {
return NO_EXPIRY;
}
/**
* INTERNAL:
* This will return true if the object is set to be invalid, false otherwise.
*/
public boolean isInvalidated(CacheKey key, long currentTimeMillis) {
return key.getInvalidationState() == CacheKey.CACHE_KEY_INVALID;
}
}