xal.tools.text

Class FormattedNumber

java.lang.Object

java.lang.Number

xal.tools.text.FormattedNumber

All Implemented Interfaces:

java.io.Serializable

public class FormattedNumber
extends java.lang.Number

Provides a number with a format which facilitates easy table display with proper number justification.

Since:

2/22/06

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.text.NumberFormat	_format the format for displaying the number
protected java.lang.Number	_number the number
protected static java.text.NumberFormat	DEFAULT_NUMBER_FORMAT default number format when none is specified

Constructor Summary

Constructors

Constructor and Description
FormattedNumber(java.lang.Number value) Constructor with the default pattern of "0.0000E###"
FormattedNumber(java.text.NumberFormat format, java.lang.Number value) Primary Constructor
FormattedNumber(java.lang.String valueString) Constructor with the default pattern of "0.0000E###".
FormattedNumber(java.lang.String pattern, java.lang.Number value) Constructor

Method Summary

Modifier and Type	Method and Description
byte	byteValue() Get the value as a byte.
double	doubleValue() Get the value as a double.
float	floatValue() Get the value as a float.
java.text.NumberFormat	getFormat() Get the format.
int	intValue() Get the value as an integer.
long	longValue() Get the value as a long.
short	shortValue() Get the value as a short.
java.lang.String	toString() Use the number format to provide the number's display representation.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NUMBER_FORMAT

protected static final java.text.NumberFormat DEFAULT_NUMBER_FORMAT

default number format when none is specified

_number

protected final java.lang.Number _number

the number

_format

protected final java.text.NumberFormat _format

the format for displaying the number

Constructor Detail

FormattedNumber

public FormattedNumber(java.text.NumberFormat format,
                       java.lang.Number value)

Primary Constructor

Parameters:

format - the number format for display

value - the value to represent

FormattedNumber

public FormattedNumber(java.lang.String pattern,
                       java.lang.Number value)

Constructor

Parameters:

pattern - decimal format pattern

value - the value to represent

FormattedNumber

public FormattedNumber(java.lang.Number value)

Constructor with the default pattern of "0.0000E###"

Parameters:

value - the value to represent

FormattedNumber

public FormattedNumber(java.lang.String valueString)

Constructor with the default pattern of "0.0000E###". This constructor is necessary to support javax.swing.text.DefaultFormatter

Parameters:

valueString - the string to parse as a number

Method Detail

getFormat

public java.text.NumberFormat getFormat()

Get the format.

Returns:

the format

byteValue

public byte byteValue()

Get the value as a byte.

Overrides:

byteValue in class java.lang.Number

Returns:

the value as a byte

doubleValue

public double doubleValue()

Get the value as a double.

Specified by:

doubleValue in class java.lang.Number

Returns:

the value as a double

floatValue

public float floatValue()

Get the value as a float.

Specified by:

floatValue in class java.lang.Number

Returns:

the value as a float

intValue

public int intValue()

Get the value as an integer.

Specified by:

intValue in class java.lang.Number

Returns:

the value as an integer

shortValue

public short shortValue()

Get the value as a short.

Overrides:

shortValue in class java.lang.Number

Returns:

the value as a short

longValue

public long longValue()

Get the value as a long.

Specified by:

longValue in class java.lang.Number

Returns:

the value as a long

toString

public java.lang.String toString()

Use the number format to provide the number's display representation.

Overrides:

toString in class java.lang.Object

Returns:

the display representation