Package org.eclipse.mat.query

Class BytesFormat

java.lang.Object

java.text.Format

org.eclipse.mat.query.BytesFormat

All Implemented Interfaces:

Serializable, Cloneable

public class BytesFormat
extends Format

This class formats an instance of Bytes, Long, Integer, or Short based on the currently configured BytesDisplay preference.

Since:

1.5

See Also:

• Serialized Form

Nested Class Summary

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

Format.Field

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DETAILED_DECIMAL_FORMAT	The default format string using for decimal byte values.

Constructor Summary

Constructors

Constructor	Description
BytesFormat()	Create an instance with default behavior.
BytesFormat(Format encapsulatedNumberFormat, Format encapsulatedDecimalFormat)	Create an instance with the behavior that if the display preference is BytesDisplay.Bytes, always use encapsulatedNumberFormat; otherwise, use encapsulatedDecimalFormat if the value is more than 1KB.
BytesFormat(Format encapsulatedNumberFormat, Format encapsulatedDecimalFormat, BytesDisplay bytesDisplay)	Create an instance with the behavior that if the display preference is BytesDisplay.Bytes, always use encapsulatedNumberFormat; otherwise, use encapsulatedDecimalFormat if the value is more than 1KB.
BytesFormat(BytesDisplay bytesDisplay)	Create an instance with default behavior.

Method Summary

Modifier and Type	Method	Description
StringBuffer	format(Object obj, StringBuffer toAppendTo, FieldPosition pos)	If obj is an instance of Bytes, long, integer or short, then consider the bytes display preference when formatting the value.
BytesDisplay	getBytesDisplay()	Gets the current BytesDisplay if any
static BytesFormat	getInstance()	Return a new instance of a BytesFormat with default options.
Object	parseObject(String source, ParsePosition pos)	Parses the input string according to the display mode.
void	setBytesDisplay(BytesDisplay bytesDisplay)	Sets the current BytesDisplay

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

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

Field Details

DETAILED_DECIMAL_FORMAT

public static final String DETAILED_DECIMAL_FORMAT

The default format string using for decimal byte values.

See Also:

• Constant Field Values

Constructor Details

BytesFormat

public BytesFormat()

Create an instance with default behavior.

BytesFormat

public BytesFormat(BytesDisplay bytesDisplay)

Create an instance with default behavior.

Parameters:

bytesDisplay - the BytesDisplay to use if any

Since:

1.17

BytesFormat

public BytesFormat(Format encapsulatedNumberFormat,
 Format encapsulatedDecimalFormat)

Create an instance with the behavior that if the display preference is BytesDisplay.Bytes, always use encapsulatedNumberFormat; otherwise, use encapsulatedDecimalFormat if the value is more than 1KB.

Parameters:

encapsulatedNumberFormat - the format for small sizes

encapsulatedDecimalFormat - the format for larger sizes

BytesFormat

public BytesFormat(Format encapsulatedNumberFormat,
 Format encapsulatedDecimalFormat,
 BytesDisplay bytesDisplay)

Create an instance with the behavior that if the display preference is BytesDisplay.Bytes, always use encapsulatedNumberFormat; otherwise, use encapsulatedDecimalFormat if the value is more than 1KB.

Parameters:

encapsulatedNumberFormat - the format for small sizes

encapsulatedDecimalFormat - the format for larger sizes

bytesDisplay - the BytesDisplay to use if any

Since:

1.17

Method Details

getBytesDisplay

public BytesDisplay getBytesDisplay()

Gets the current BytesDisplay if any

Returns:

the BytesDisplay

Since:

1.17

setBytesDisplay

public void setBytesDisplay(BytesDisplay bytesDisplay)

Sets the current BytesDisplay

Parameters:

bytesDisplay - the BytesDisplay to set

Since:

1.17

format

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

If obj is an instance of Bytes, long, integer or short, then consider the bytes display preference when formatting the value. Otherwise, format obj using the default formatter.

Specified by:

format in class Format

parseObject

public Object parseObject(String source,
 ParsePosition pos)

Parses the input string according to the display mode. Returns a Bytes object

Specified by:

parseObject in class Format

getInstance

public static BytesFormat getInstance()

Return a new instance of a BytesFormat with default options.

Returns:

a default BytesFormat