com.wassilak.cache_service.entity

Interface Entity<T>

Type Parameters:

T - The type of object that this Entity represents in a Cache.

All Superinterfaces:

Serializable

public interface Entity<T>
extends Serializable

The Entity interface defines the behavior of the cache-service Entity object, which represents cached objects.

Copyright (C) 2014 John Wassilak (john@wassilak.com)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Field Summary

Fields

Modifier and Type	Field and Description
static Long	MAX_TTL The MAX_TTL constant represents the maximum allowable value of an Entity's timeToLive property.
static Long	MIN_TTL The MIN_TTL constant represents the minimum allowable value of an Entity's timeToLive property.

Method Summary

Modifier and Type	Method and Description
T	getObject() The getObject method returns the underlying object that this cache Entity represents.
Date	getTimeStamp() The getTimeStamp method returns the date/time that the entity was created.
Long	getTimeToLive() The getTimeToLive method returns the time that the Entity can live before it should be removed from the cache, in milliseconds.

Field Detail

MIN_TTL

static final Long MIN_TTL

The MIN_TTL constant represents the minimum allowable value of an Entity's timeToLive property.

MAX_TTL

static final Long MAX_TTL

The MAX_TTL constant represents the maximum allowable value of an Entity's timeToLive property.

Method Detail

getObject

T getObject()

The getObject method returns the underlying object that this cache Entity represents.

Returns:

The cached object.

getTimeStamp

Date getTimeStamp()

The getTimeStamp method returns the date/time that the entity was created. This is used in determining whether or not the Entity should be considered expired and removed from the cache.

Returns:

The date/time that the Entity was created.

getTimeToLive

Long getTimeToLive()

The getTimeToLive method returns the time that the Entity can live before it should be removed from the cache, in milliseconds.

Returns:

The length of time before the Entity should expire and be removed from the cache.