js.format

Class BitRate

java.lang.Object

js.format.BitRate

All Implemented Interfaces:

Format

public final class BitRate
extends Object
implements Format

Bit rate format - 12.30 Kbps. Bit rate format has a numeric part and units; units are selected so that bit rate to be represented with smallest numeric part but greater or equals one. Numeric part is formatted according locale settings and always has two decimals. For supported units take a look at BitRate.Units class.

Version:

final

Author:

Iulian Rotaru

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	BitRate.Units Bit rate measurement units.

Field Summary

Fields

Modifier and Type	Field and Description
private NumberFormat	numberFormat Formatter for bit rate numeric part.

Constructor Summary

Constructors

Constructor and Description
BitRate() Construct bit rate formatter instance with default locale.
BitRate(Locale locale) Construct bit rate formatter instance for requested locale settings.

Method Summary

Modifier and Type	Method and Description
private String	format(double bitRate, BitRate.Units units) Build bit rate representation for given numeric value and units.
String	format(Object value) Format a integer or long value as bit rate.
Object	parse(String value) Parse bit rate 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 bit rate numeric part. It is subject of locale adjustments.

Constructor Detail

BitRate

public BitRate()

Construct bit rate formatter instance with default locale.

BitRate

public BitRate(Locale locale)

Construct bit rate 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 bit rate. Returns empty string if value argument is null.

Specified by:

format in interface Format

Parameters:

value - numeric value.

Returns:

numeric value represented as bit rate, 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 bit rate 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 BitRate.Units for supported units.

Returns null if value argument is null or empty.

Specified by:

parse in interface Format

Parameters:

value - formatted bit rate 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 bitRate,
                      BitRate.Units units)

Build bit rate representation for given numeric value and units.

Parameters:

bitRate - bit rate numeric part value,

units - bit rate units.

Returns:

formated bit rate.