dk.heick.caching.persistences.file

Class CachingDirectory

java.lang.Object

dk.heick.caching.persistences.file.CachingDirectory

public class CachingDirectory
extends Object

Defines the directory where cached values is stored in files.
Do not put any other files in this directory, this is the cachings directory exclusively.

Since:

1.0

Author:

Frederik Heick

Constructor Summary

Constructors

Constructor and Description
CachingDirectory(File directory) Constructor, where recursive is false.
CachingDirectory(File directory, boolean recursive) Constructor.
CachingDirectory(File directory, SubDirectoryCreator subDirectoryCreator) Constructor with recursive set to true.

Method Summary

Modifier and Type	Method and Description
int	delete() Delete everything inside the "directory" which matches the filter and recursive.
boolean	equals(Object obj) Equals if the both is of class CachingDirectory and has the same directory.
File	getDirectory() The caching directory of which must exists and be of type directory.
Logger	getLogger() Gets the logger
File	getSubDirectory(String key) From a filename "String" (which is the key) construct a subdirectory if needed to put the value files in different directories. This could be to limit the the number of files in a directory, or be able to view a sub directory with certain type of values. This will use the "SubDirectoryCreator" (if any) to a create a sub directory to store the value file in, this is only allowed is recursive is true. The default behaviour is that there is no "SubDirectoryCreator", and all files will be stored directly in the caching directory.
SubDirectoryCreator	getSubDirectoryCreator() Gets the SubDirectoryCreator
int	hashCode()
boolean	isRecursive() If the caching directory has multiple levels or not.
void	setSubDirectoryCreator(SubDirectoryCreator subDirectoryCreator) Sets the SubDirectoryCreator
int	size() The number of files and directories in the directory, not resursive.
void	validate() Validates that this "instance" is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingDirectory

public CachingDirectory(File directory)

Constructor, where recursive is false.

Parameters:

directory - the root directory, must exists and must be a directory.

See Also:

File.isDirectory(), File.exists()

CachingDirectory

public CachingDirectory(File directory,
                        boolean recursive)

Constructor.

Parameters:

directory - the root directory, must exists and must be a directory.

recursive - if the directory has multiple levels or not.

CachingDirectory

public CachingDirectory(File directory,
                        SubDirectoryCreator subDirectoryCreator)

Constructor with recursive set to true.

Parameters:

directory - the root directory, must exists and must be a directory.

subDirectoryCreator - the SubDirectoryCreator

Method Detail

validate

public void validate()
              throws IllegalArgumentException,
                     NullPointerException

Validates that this "instance" is valid.

Throws:

IllegalArgumentException - if "getDirectory().getAbsolutePath()" is do not exists, is not a directory, is not readable or writeable.

NullPointerException - "getDirectory()" is null.¨

See Also:

getDirectory(), File.exists(), File.isDirectory(), File.canRead(), File.canWrite()

isRecursive

public final boolean isRecursive()

If the caching directory has multiple levels or not.
Do we want to look down into sub directories or not.

Returns:

true, if sub directories is involved, otherwise false.

See Also:

getSubDirectoryCreator()

getDirectory

public final File getDirectory()

The caching directory of which must exists and be of type directory.

Returns:

the directory.

See Also:

File.exists(), File.isDirectory()

size

public final int size()

The number of files and directories in the directory, not resursive.

Returns:

the number of directories and files in the primary directory.

See Also:

getDirectory()

delete

public final int delete()

Delete everything inside the "directory" which matches the filter and recursive.
But not the directory it self.

See Also:

getDirectory(), isRecursive()

getSubDirectoryCreator

public final SubDirectoryCreator getSubDirectoryCreator()

Gets the SubDirectoryCreator

Returns:

SubDirectoryCreator, null is allowed, and the caching directory is used, this is default behaviour.

See Also:

getDirectory()

setSubDirectoryCreator

public final void setSubDirectoryCreator(SubDirectoryCreator subDirectoryCreator)

Sets the SubDirectoryCreator

Parameters:

subDirectoryCreator - the SubDirectoryCreator

getSubDirectory

public final File getSubDirectory(String key)

From a filename "String" (which is the key) construct a subdirectory if needed to put the value files in different directories.
This could be to limit the the number of files in a directory, or be able to view a sub directory with certain type of values.
This will use the "SubDirectoryCreator" (if any) to a create a sub directory to store the value file in, this is only allowed is recursive is true.
The default behaviour is that there is no "SubDirectoryCreator", and all files will be stored directly in the caching directory.

Parameters:

key - the key which is the filename.

Returns:

the directory the value file will be stored in.

See Also:

File.getName(), getDirectory(), getSubDirectoryCreator()

equals

public final boolean equals(Object obj)

Equals if the both is of class CachingDirectory and has the same directory.

Overrides:

equals in class Object

See Also:

getDirectory()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getLogger

public Logger getLogger()

Gets the logger

Returns:

the logger