org.jivesoftware.util

Class ByteFormat

java.lang.Object

java.text.Format

org.jivesoftware.util.ByteFormat

All Implemented Interfaces:

Serializable, Cloneable

public class ByteFormat
extends Format

A formatter for formatting byte sizes. For example, formatting 12345 byes results in "12.1 K" and 1234567 results in "1.18 MB".

Author:

Bill Lynch

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Format.Field

Constructor Summary

Constructors

Constructor and Description
ByteFormat()

Method Summary

Modifier and Type	Method and Description
String	format(long bytes) Formats a long which represent a number of bytes.
StringBuffer	format(Object obj, StringBuffer buf, FieldPosition pos) Format the given object (must be a Long).
String	formatKB(long kilobytes) Formats a long which represent a number of kilobytes.
Object	parseObject(String source, ParsePosition pos) In this implementation, returns null always.

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteFormat

public ByteFormat()

Method Detail

format

public String format(long bytes)

Formats a long which represent a number of bytes.

Parameters:

bytes - the number of bytes to format

Returns:

the formatted string

formatKB

public String formatKB(long kilobytes)

Formats a long which represent a number of kilobytes.

Parameters:

kilobytes - the number of kilobytes to format

Returns:

the formatted string

format

public StringBuffer format(Object obj,
                           StringBuffer buf,
                           FieldPosition pos)

Format the given object (must be a Long).

Specified by:

format in class Format

Parameters:

obj - assumed to be the number of bytes as a Long.

buf - the StringBuffer to append to.

pos - the field position

Returns:

A formatted string representing the given bytes in more human-readable form.

parseObject

public Object parseObject(String source,
                          ParsePosition pos)

In this implementation, returns null always.

Specified by:

parseObject in class Format

Parameters:

source - unused parameter

pos - unused parameter

Returns:

returns null in this implementation.