|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Object java.lang.Enum<Location> net.sf.basedb.core.Location
public enum Location
This enumeration defines constants that are used to specify different file storage locations.
Enum Constant Summary | |
---|---|
EXTERNAL
The item is stored externally. |
|
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. |
Field Summary | |
---|---|
private String |
displayValue
Returned by the toString method. |
private boolean |
downloadable
If the file can be downloaded from this location. |
private boolean |
quotaLimited
If this location is limited by quota. |
private int |
value
The integer value of this location. |
private static Map<Integer,Location> |
valueMapping
Maps an integer to a location. |
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. |
boolean |
isDownloadable()
A flag indicating if a file that is stored at this location can be downloaded by a call to File.getDownloadStream(long)
or File.download(java.io.OutputStream, long) . |
boolean |
isQuotaLimited()
A flag indicating if a file that is stored at this location should be included in quota limit. |
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 |
---|
public static final Location OFFLINE
public static final Location PRIMARY
public static final Location SECONDARY
public static final Location EXTERNAL
Field Detail |
---|
private static final Map<Integer,Location> valueMapping
private final int value
private final String displayValue
private final boolean downloadable
private final boolean quotaLimited
Method Detail |
---|
public static Location[] values()
for (Location c : Location.values()) System.out.println(c);
public static Location valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic String toString()
toString
in class Enum<Location>
public static Location fromValue(int value)
Location
object when you know the integer code.
value
- The integer value.
public int getValue()
public boolean isDownloadable()
File.getDownloadStream(long)
or File.download(java.io.OutputStream, long)
.
public boolean isQuotaLimited()
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |