Package org.deltava.util.cache

Class CacheableFile

java.lang.Object

java.io.File

org.deltava.util.cache.CacheableFile

All Implemented Interfaces:

Serializable, Comparable<File>, Cacheable

public class CacheableFile
extends File
implements Cacheable

A utility class to create a cacheable File.

Since:

2.2

Version:

5.0

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor	Description
CacheableFile(File f)	Creates a cache entry for a File.
CacheableFile(Object key, File f)	Creates a cache entry for a File with a specific key.

Method Summary

Modifier and Type	Method	Description
Object	cacheKey()	Returns the cache key for this object.

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

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

Constructor Details

CacheableFile

public CacheableFile(File f)

Creates a cache entry for a File.

Parameters:

f - the File

CacheableFile

public CacheableFile(Object key,
 File f)

Creates a cache entry for a File with a specific key.

Parameters:

key - the key

f - the File

Method Details

cacheKey

public Object cacheKey()

Description copied from interface: Cacheable

Returns the cache key for this object. Caches call this method when adding the object.

Specified by:

cacheKey in interface Cacheable

Returns:

the cache key for the object