com.screenscraper.datamanager.skeleton.cache

Class CachedPage

java.lang.Object

com.screenscraper.datamanager.skeleton.cache.CachedPage

All Implemented Interfaces:

java.lang.Comparable<CachedPage>

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

Represents a cached page

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CachedPage.Builder Builder class to create a cached page

Constructor Summary

Constructors

Constructor and Description
CachedPage(java.lang.String name, java.lang.String url, java.lang.String mimeType, byte[] data, java.lang.String generatedHash, java.util.Date cacheTime)

Method Summary

Modifier and Type	Method and Description
int	compareTo(CachedPage o) Compares this object with the specified object for order.
boolean	equals(java.lang.Object o)
java.util.Date	getCacheTime() Returns the CacheTime for the page (if this isn't null, it should be more accurate than the cache block's time)
byte[]	getData() Returns the Data for the object
java.lang.String	getDataString() Returns the data as a string
java.lang.String	getGeneratedHash() Returns the GeneratedHash for the object
java.lang.String	getMimeType() Returns the MimeType for the object
java.lang.String	getName() Returns the Name for the object
java.lang.String	getUrl() Returns the Url for the object
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedPage

CachedPage(@NotNull
           java.lang.String name,
           @Nullable
           java.lang.String url,
           @NotNull
           java.lang.String mimeType,
           @NotNull
           byte[] data,
           @NotNull
           java.lang.String generatedHash,
           java.util.Date cacheTime)

Method Detail

getGeneratedHash

@NotNull
public java.lang.String getGeneratedHash()

Returns the GeneratedHash for the object

Returns:

The GeneratedHash for the object

getName

@NotNull
public java.lang.String getName()

Returns the Name for the object

Returns:

The Name for the object

getUrl

@Nullable
public java.lang.String getUrl()

Returns the Url for the object

Returns:

The Url for the object

getMimeType

@NotNull
public java.lang.String getMimeType()

Returns the MimeType for the object

Returns:

The MimeType for the object

getData

@NotNull
public byte[] getData()

Returns the Data for the object

Returns:

The Data for the object

getDataString

@NotNull
public java.lang.String getDataString()

Returns the data as a string

Returns:

The data as a string

getCacheTime

@Nullable
public java.util.Date getCacheTime()

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

Returns:

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

compareTo

public int compareTo(@NotNull
                     CachedPage o)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.

It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."

In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.

Specified by:

compareTo in interface java.lang.Comparable<CachedPage>

Parameters:

o - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.NullPointerException - if the specified object is null

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this object.

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