com.hazelcast.internal.eviction.Expirable Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
*
* 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.hazelcast.internal.eviction;
/**
* Expiring Data model interface.
* This interface provides a time variable to be compared against other time values
* to decide on "future" or "past".
*/
public interface Expirable {
/**
* Gets the expiration time in milliseconds.
* @return expiration time.
* @see System#currentTimeMillis()
*/
long getExpirationTime();
/**
* Sets the expiration time in milliseconds.
* @param expirationTime
* @see System#currentTimeMillis()
*/
void setExpirationTime(long expirationTime);
/**
* Checks whether the expiration time is passed with respect to the provided time.
* Returns true if and only if {@code now > getExpirationTime()}
.
* @param now time in milliseconds.
* @return true if expired.
*/
boolean isExpiredAt(long now);
}