com.github.wuic.util

Enum NutDiskStore

java.lang.Object

java.lang.Enum<NutDiskStore>

com.github.wuic.util.NutDiskStore

All Implemented Interfaces:

Serializable, Comparable<NutDiskStore>, Runnable

public enum NutDiskStore
extends Enum<NutDiskStore>
implements Runnable

This class stores nuts in a dedicated temporary directory. The class keeps all version numbers of nuts when they are stored so the file is actually copied only if its number version is changed in order to boost performances. A thread is registered via Runtime.addShutdownHook(Thread) to clean directory when JVM stops properly.

Since:

0.5.1

Version:

1.0

Author:

Guillaume DROUET

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton.

Method Summary

Methods

Modifier and Type	Method and Description
File	getWorkingDirectory() Gets the working directory.
void	run()
File	store(ConvertibleNut nut) Creates a File for the given nut and returns the object created for the stored file.
static NutDiskStore	valueOf(String name) Returns the enum constant of this type with the specified name.
static NutDiskStore[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final NutDiskStore INSTANCE

Singleton.

Method Detail

values

public static NutDiskStore[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NutDiskStore c : NutDiskStore.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NutDiskStore valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getWorkingDirectory

public File getWorkingDirectory()

Gets the working directory.

Returns:

the working directory

store

public File store(ConvertibleNut nut)
           throws IOException,
                  InterruptedException,
                  ExecutionException

Creates a File for the given nut and returns the object created for the stored file. null will be returned if the file already exists and has the same version number.

Parameters:

nut - the nut to store

Returns:

the file

Throws:

IOException - if file cannot be created

InterruptedException - if version number can't be retrieved

ExecutionException - if version number can't be retrieved

run

public void run()

Specified by:

run in interface Runnable