org.proteios.core
Enum Location

java.lang.Object
  java.lang.Enum<Location>
      org.proteios.core.Location

All Implemented Interfaces:

Serializable, Comparable<Location>

public enum Location
extends Enum<Location>

This enumeration defines constants that are used to specify different file storage locations.

Version:

2.0

Author:

enell

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Enum Constant Summary

OFFLINE
The item is offline and doesn't use any quota.

PRIMARY
The item is stored in primary storage.

SECONDARY
The item is stored in secondary storage.

Method Summary

static Location	fromValue(int value) Get the Location object when you know the integer code.
int	getValue() Get the integer value that is used when storing an location to the database.
String	toString()
static Location	valueOf(String name) Returns the enum constant of this type with the specified name.
static Location[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OFFLINE

public static final Location OFFLINE

The item is offline and doesn't use any quota.

PRIMARY

public static final Location PRIMARY

The item is stored in primary storage.

SECONDARY

public static final Location SECONDARY

The item is stored in secondary storage. Note! This type of storage may not be available on all servers.

Method Detail

values

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

Returns:

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

valueOf

public static Location 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

toString

public String toString()

Overrides:

toString in class Enum<Location>

fromValue

public static Location fromValue(int value)

Get the Location object when you know the integer code.

Parameters:

value - The integer value.

Returns:

The location for the integer value.

getValue

public int getValue()

Get the integer value that is used when storing an location to the database.

Returns:

The integer value for this location.