Package org.cyclos.model.utils

Enum FileSizeUnit

java.lang.Object

java.lang.Enum<FileSizeUnit>

org.cyclos.model.utils.FileSizeUnit

All Implemented Interfaces:

Serializable, Comparable<FileSizeUnit>, HasMessageKey

public enum FileSizeUnit
extends Enum<FileSizeUnit>
implements HasMessageKey

Possible units for a file size

Enum Constant Summary

Enum Constants

Enum Constant	Description
B
G
K
M

Method Summary

Modifier and Type	Method	Description
int	getBytes()	Returns the number of bytes in this unit
MessageKey	getMessageKey()
static FileSizeDTO	nearestFileSize(long length)	Returns a FileSizeDTO containing the nearest unit for the given length in bytes.
static Pair<Number,FileSizeUnit>	nearestFileSize(long length, boolean truncate)
static FileSizeUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FileSizeUnit[]	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

B

public static final FileSizeUnit B

K

public static final FileSizeUnit K

M

public static final FileSizeUnit M

G

public static final FileSizeUnit G

Method Detail

values

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

Returns:

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

valueOf

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

nearestFileSize

public static FileSizeDTO nearestFileSize(long length)

Returns a FileSizeDTO containing the nearest unit for the given length in bytes. For example: 100 returns 100B, 1300 return 1K, 11000000 returns 10M

nearestFileSize

public static Pair<Number,FileSizeUnit> nearestFileSize(long length,
                                                              boolean truncate)

getBytes

public int getBytes()

Returns the number of bytes in this unit

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey