js.format

Class FileSize

java.lang.Object

js.format.FileSize

All Implemented Interfaces:

Format

public final class FileSize
extends Object
implements Format

File size format - 12.3KB. A file size has a numeric part and units; units are selected so that to be represented with smallest numeric part but greater or equals one. Numeric part is formatted according locale settings. For supported units take a look at FileSize.Units class.

Version:

final

Author:

Iulian Rotaru

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	FileSize.Units File size measurement units.

Field Summary

Fields

Modifier and Type	Field and Description
private NumberFormat	numberFormat Formatter for file size numeric part.

Constructor Summary

Constructors

Constructor and Description
FileSize() Construct file size formatter instance with default locale.
FileSize(Locale locale) Construct file size formatter instance for requested locale settings.

Method Summary

Modifier and Type	Method and Description
private String	format(double fileSize, FileSize.Units units) Build file size representation for given numeric value and units.
String	format(Object value) Format a integer or long value as file size.
Object	parse(String value) Parse file size from given string value and return it as Long instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

numberFormat

private NumberFormat numberFormat

Formatter for file size numeric part. It is subject of locale adjustments.

Constructor Detail

FileSize

public FileSize()

Construct file size formatter instance with default locale.

FileSize

public FileSize(Locale locale)

Construct file size formatter instance for requested locale settings.

Parameters:

locale - locale settings.

Method Detail

format

public String format(Object value)

Format a integer or long value as file size. Returns empty string if value argument is null.

Specified by:

format in interface Format

Parameters:

value - numeric value.

Returns:

numeric value represented as file size, possible empty if value argument is null.

Throws:

IllegalArgumentException - if value argument is not integer or long.

parse

public Object parse(String value)
             throws ParseException

Parse file size from given string value and return it as Long instance. Given string value should have a numeric part followed by units, separated by space. See FileSize.Units for supported units.

Returns null if value argument is null or empty.

Specified by:

parse in interface Format

Parameters:

value - file size value.

Returns:

file size as Long instance, possible null if value argument is null or empty.

Throws:

ParseException - if value is not formated as described above.

format

private String format(double fileSize,
                      FileSize.Units units)

Build file size representation for given numeric value and units.

Parameters:

fileSize - file size numeric part value,

units - file size units.

Returns:

formated file size.