net.wildfyre.descriptors

Class Descriptor

java.lang.Object

net.wildfyre.descriptors.Descriptor

Direct Known Subclasses:

User

public abstract class Descriptor
extends java.lang.Object

Descriptors represent the raw data from the server, and are used by the internal cache. This class is NOT part of the public API.

Constructor Summary

Constructors

Constructor and Description
Descriptor()

Method Summary

Modifier and Type	Method and Description
boolean	isNew() Permits to know if this object was ever used before.
boolean	isValid() Checks if this descriptor is still valid.
boolean	isValid(long currentTime) Checks if this descriptor is still valid.
static void	setTimeBeforeRemoval(long timeBeforeRemoval) Set the time of validation of the cache.
abstract void	update() Updates this Descriptor.
void	use() Marks this descriptors' last usage as now.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Descriptor

public Descriptor()

Method Detail

setTimeBeforeRemoval

public static void setTimeBeforeRemoval(long timeBeforeRemoval)

Set the time of validation of the cache.

Parameters:

timeBeforeRemoval - the time of validation, in milliseconds.

isValid

public boolean isValid(long currentTime)

Checks if this descriptor is still valid.

Parameters:

currentTime - the current time in milliseconds, as provided by System.currentTimeMillis().

Returns:

true if this descriptor is valid.

See Also:

Shortcut without the currentTime parameter

isValid

public final boolean isValid()

Checks if this descriptor is still valid.

Returns:

true if this descriptor is valid.

See Also:

For large collections

isNew

public final boolean isNew()

Permits to know if this object was ever used before.

This method tracks whether use() was ever called on this object (except by the initializer).

Returns:

true if this object has already been used at least once.

use

public final void use()

Marks this descriptors' last usage as now.

update

public abstract void update()

Updates this Descriptor.

The update is always executed in the current thread.