2.17.2: 2011-06-17

net.sf.basedb.core
Enum File.Action

java.lang.Object
  extended by java.lang.Enum<File.Action>
      extended by net.sf.basedb.core.File.Action
All Implemented Interfaces:
Serializable, Comparable<File.Action>
Enclosing class:
File

public static enum File.Action
extends Enum<File.Action>

A fileaction describes if a file should be moved to secondary storage or brought back from it. The actual moving of the file is done by an external progam.

Author:
enell

Enum Constant Summary
MOVE_TO_PRIMARY
          The file should be brought back from secondary storage.
MOVE_TO_SECONDARY
          The file should be moved to secondary storage
NOTHING
          Do nothing.
 
Field Summary
private  int value
          The integer value of this fileaction.
private static Map<Integer,File.Action> valueMapping
          Maps the integer that is stored in the database with an fileaction.
 
Method Summary
static File.Action fromValue(int value)
          Get the File.Action object when you know the integer code.
 int getValue()
          Get the integer value that is used when storing an File.Action to the database.
static File.Action valueOf(String name)
          Returns the enum constant of this type with the specified name.
static File.Action[] 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

NOTHING

public static final File.Action NOTHING
Do nothing.


MOVE_TO_PRIMARY

public static final File.Action MOVE_TO_PRIMARY
The file should be brought back from secondary storage.


MOVE_TO_SECONDARY

public static final File.Action MOVE_TO_SECONDARY
The file should be moved to secondary storage

Field Detail

valueMapping

private static final Map<Integer,File.Action> valueMapping
Maps the integer that is stored in the database with an fileaction.


value

private final int value
The integer value of this fileaction.

Method Detail

values

public static File.Action[] 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 (File.Action c : File.Action.values())
    System.out.println(c);

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

valueOf

public static File.Action 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

fromValue

public static File.Action fromValue(int value)
Get the File.Action object when you know the integer code.

Parameters:
value - The integer value.
Returns:
The fileaction for the integer value.

getValue

public int getValue()
Get the integer value that is used when storing an File.Action to the database.

Returns:
The intger value of this action.

2.17.2: 2011-06-17