com.screenscraper.datamanager.skeleton.cache

Class CachedContext

java.lang.Object

com.screenscraper.datamanager.skeleton.cache.CachedContext

All Implemented Interfaces:

java.lang.Comparable<CachedContext>

public class CachedContext
extends java.lang.Object
implements java.lang.Comparable<CachedContext>

Represents cached context

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
CachedContext(java.lang.String key, java.lang.Object value) Builds the context with a given key and value
CachedContext(java.lang.String key, java.lang.Object value, java.util.Date cacheTime) Builds the context with a given key and value

Method Summary

Modifier and Type	Method and Description
int	compareTo(CachedContext other)
boolean	equals(java.lang.Object o)
java.util.Date	getCacheTime() Returns the CacheTime for the context (if this isn't null, it should be more accurate than the cache block's time)
java.lang.Object	getId() Returns the Id for the object (this can be used to track things in a database if needed, but isn't used for anything other than a custom use)
java.lang.String	getKey() Returns the Key for the object
java.lang.Object	getValue() Returns the Value for the object
int	hashCode()
void	setId(java.lang.Object id) Sets the Id for the object (this can be used to track things in a database if needed, but isn't used for anything other than a custom use)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CachedContext

public CachedContext(@NotNull
                     java.lang.String key,
                     @Nullable
                     java.lang.Object value)

Builds the context with a given key and value

Parameters:

key - The context key

value - The context value

CachedContext

public CachedContext(@NotNull
                     java.lang.String key,
                     @Nullable
                     java.lang.Object value,
                     @Nullable
                     java.util.Date cacheTime)

Builds the context with a given key and value

Parameters:

key - The context key

value - The context value

cacheTime - The time this was cached. This is optional and can be used if the time from the corresponding block isn't accurate

Method Detail

getId

@Nullable
public java.lang.Object getId()

Returns the Id for the object (this can be used to track things in a database if needed, but isn't used for anything other than a custom use)

Returns:

The Id for the object (this can be used to track things in a database if needed, but isn't used for anything other than a custom use)

Since:

7.0.9a

setId

public void setId(@Nullable
                  java.lang.Object id)

Sets the Id for the object (this can be used to track things in a database if needed, but isn't used for anything other than a custom use)

Parameters:

id - The new value for Id (this can be used to track things in a database if needed, but isn't used for anything other than a custom use)

Since:

7.0.9a

getKey

@NotNull
public java.lang.String getKey()

Returns the Key for the object

Returns:

The Key for the object

getValue

@Nullable
public java.lang.Object getValue()

Returns the Value for the object

Returns:

The Value for the object

getCacheTime

@Nullable
public java.util.Date getCacheTime()

Returns the CacheTime for the context (if this isn't null, it should be more accurate than the cache block's time)

Returns:

The CacheTime for the context (if this isn't null, it should be more accurate than the cache block's time)

compareTo

public int compareTo(@NotNull
                     CachedContext other)

Specified by:

compareTo in interface java.lang.Comparable<CachedContext>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object