senselogic.sitevision.api.format

Interface NumericFormatter

public interface NumericFormatter

Numerical value formatter.

An instance of the Sitevision class implementing this interface can be obtained via a builder created via FormatterBuilderFactory.

Since:

Sitevision 6.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
String	format(Object aObject) Formats a Object value.
String	formatDouble(double aNumber) Formats a double value.
String	formatLong(long aNumber) Formats a long value.
Number	parse(String aSource) Parses a source string to a Number.

Method Detail

formatDouble

String formatDouble(double aNumber)
             throws ArithmeticException

Formats a double value.

This method is conceptually equivalent with java.text.NumberFormat.format(double).

Parameters:

aNumber - a double value

Returns:

a formatted result

Throws:

ArithmeticException - if a mathematical operation fails

formatLong

String formatLong(long aNumber)
           throws ArithmeticException

Formats a long value.

This method is conceptually equivalent with java.text.NumberFormat.format(long).

Parameters:

aNumber - a long value

Returns:

a formatted result

Throws:

ArithmeticException - if a mathematical operation fails

format

String format(Object aObject)
       throws NullPointerException,
              IllegalArgumentException,
              ArithmeticException

Formats a Object value.

This method is conceptually equivalent with java.text.NumberFormat.format(Object).

Parameters:

aObject - a Object, typically a java.lang.Number

Returns:

a formatted result

Throws:

NullPointerException - if aObject is null

IllegalArgumentException - if aObject is of an unsupported type (e.g. not numerical)

ArithmeticException - if a mathematical operation fails

parse

Number parse(String aSource)
      throws NullPointerException,
             ParseException

Parses a source string to a Number.

This method is conceptually equivalent with java.text.NumberFormat.parse(String).

Parameters:

aSource - a string, typically the resulting string from a format operation of a formatter like this

Returns:

the Number object parsed from aSource

Throws:

NullPointerException - if aSource is null

ParseException - if parsing of aSource fails