com.xmlmind.xml.load

Class DocumentCache.Entry

java.lang.Object

com.xmlmind.xml.load.DocumentCache.Entry

Enclosing class:

DocumentCache

public static class DocumentCache.Entry
extends Object

An entry in the document cache.

This class is thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
Document	document The cached document.
File	file If url is a "file:" URL, this field contains the corresponding file.
long	lastModified The last modification date of the cached document.
int	loadOptions A OR-ed mask containing the LoadOptions that were used to load the cached document.
long	size The size in bytes of the cached document.
URL	url The location of the cached document.

Constructor Summary

Constructors

Constructor and Description
Entry(URL url, Document document, int loadOptions, File file, long lastModified, long size) Constructs a fully initialized cache entry.

Method Summary

Modifier and Type	Method and Description
Object	addProperty(Object key, Supplier<Object> value) Returns the value of specified property if it already exists; creates it and adds it before returning it otherwise.
Object	getProperty(Object key) Returns the value of specified property.
Object	setProperty(Object key, Object value) Adds, replaces or remove a property.
String	toString() Returns a string representation of this entry which is suitable for debugging and testing.

Methods inherited from class java.lang.Object

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

Field Detail

url

public final URL url

The location of the cached document.

document

public final Document document

The cached document.

loadOptions

public final int loadOptions

A OR-ed mask containing the LoadOptions that were used to load the cached document.

file

public final File file

If url is a "file:" URL, this field contains the corresponding file. Hence, this field may be null.

lastModified

public final long lastModified

The last modification date of the cached document. Is negative or null if unknown, in which case this entry will discarded the next time the client code will attempt to fetch it.

size

public final long size

The size in bytes of the cached document. Is negative if unknown, in which case this entry will discarded the next time the client code will attempt to fetch it.

Constructor Detail

Entry

public Entry(URL url,
             Document document,
             int loadOptions,
             File file,
             long lastModified,
             long size)

Constructs a fully initialized cache entry.

Method Detail

toString

public String toString()

Returns a string representation of this entry which is suitable for debugging and testing.

Overrides:

toString in class Object

getProperty

public Object getProperty(Object key)

Returns the value of specified property.

Parameters:

key - the property name

Returns:

the value of the property if found and null otherwise.

setProperty

public Object setProperty(Object key,
                          Object value)

Adds, replaces or remove a property.

Parameters:

key - the property name

value - the property value; specify null to remove the property

Returns:

previous property value if property has been removed or replaced; null if property has been added

addProperty

public Object addProperty(Object key,
                          Supplier<Object> value)

Returns the value of specified property if it already exists; creates it and adds it before returning it otherwise.

Parameters:

key - the property name

value - specifies how to create the property value

Returns:

the value of the property