dk.heick.caching.persistences.file.subdirectory

Class CharactersSubDirectoryCreator

java.lang.Object

dk.heick.caching.persistences.file.subdirectory.CharactersSubDirectoryCreator

All Implemented Interfaces:

SubDirectoryCreator

public class CharactersSubDirectoryCreator
extends Object
implements SubDirectoryCreator

Creates subdirectories on the basis of the Key as a String.
The key(String) must have a minimum length, otherwise default is used ('x'*minLength).
The algorithm is this.

• If key(String) is greather than "minLength", the directory is the first "minLength" characters of the Key.
• Otherwise same as above, but using the "Key(String).hashcode()" as String value.
• Otherwise using "xxxxxxxxx" with the length of "minLength".
.

Since:

1.0

Author:

Frederik Heick

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_DIRECTORY_NAME_CHAR The default character used.

Constructor Summary

Constructors

Constructor and Description
CharactersSubDirectoryCreator(int subDirectoriesNameLength) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getDefaultName() The default subdirectory name if "key" string length is below "subDirectoriesNameLength".
int	getSubDirectoriesNameLength() The length of the subdirectories created on the basis of the key.
File	getSubDirectory(File directory, String key) Construct a sub

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DIRECTORY_NAME_CHAR

public static final char DEFAULT_DIRECTORY_NAME_CHAR

The default character used.

See Also:

Constant Field Values

Constructor Detail

CharactersSubDirectoryCreator

public CharactersSubDirectoryCreator(int subDirectoriesNameLength)
                              throws IllegalArgumentException

Constructor.

Parameters:

subDirectoriesNameLength - the length of the subdirectories create on the basis of the key.

Throws:

IllegalArgumentException - if subDirectoriesNameLength is less than one.

Method Detail

getSubDirectory

public File getSubDirectory(File directory,
                            String key)

Description copied from interface: SubDirectoryCreator

Construct a sub

Specified by:

getSubDirectory in interface SubDirectoryCreator

Parameters:

directory - the base directory which is the default place to store the file value.

key - which is also the filename.

Returns:

a directory in where the file value will be stored, "CachingDirectory.getSubDirectory(String)" will have the responsility to create the directory/subdirectories.

See Also:

File.getName(), CachingDirectory.getSubDirectory(String)

getDefaultName

public final String getDefaultName()

The default subdirectory name if "key" string length is below "subDirectoriesNameLength".

Returns:

a series of "x" as long as "subDirectoriesNameLength".

getSubDirectoriesNameLength

public final int getSubDirectoriesNameLength()

The length of the subdirectories created on the basis of the key.

Returns:

the subdirectory name length.