NumberFormatter (de.mpg.mpi-inf:javatools 1.1 API)

java.lang.Object
- javatools.parsers.NumberFormatter

```
public class NumberFormatter
extends Object
```
Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This class is a simple number formatter. Furthermore, this class offers some methods for the ISO8601 time format
Example:
```
         System.out.println(new NumberFormatter("+##.###").format(3.1119));
         -->      +03.112
         System.out.println(NumberFormatter.ISOtime());
         -->      2006-01-17 T 21:01:00.000
         System.out.println(NumberFormatter.ISOweekTime());
         -->      2006-w03-2 T 21:01:00.000
   
```
The pattern for numbers may look like
```
        [+|-|+/-]  #*[x]#* [.#*]

   
```
without blanks. 'x' is a separator character for groups of 3 digits. Only one x will be recognized and it will always separate groups of 3, no matter where it appears. Examples:
```
       +###.#####
       -#
       +/-#.######
       ##
       +#'###'###.##
   
```
If the formatted number is negative, a negative sign is always output. If the number is positive, a sign will only be output if the pattern starts with "+" or "+/-". The output will contain at least as many digits as specified in the pattern. If the integer part of a number contains more digits than specified in the pattern, the digits will be output nevertheless. If the fractional part of a number contains more digits than specified in the pattern, the number will be rounded and the digits will not be output. Instead of '#', you may write digits.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`append` What shall be appended
`static NumberFormatter`	`fiveDigits` Predefined NumberFormatter for #####
`protected Pattern`	`FORMAT` Pattern for the pattern string
`static NumberFormatter`	`fourDigits` Predefined NumberFormatter for ####
`static NumberFormatter`	`fourFractions` Predefined NumberFormatter for #.####
`protected int`	`fractions` Holds the number of fraction digits
`protected int`	`integers` Holds the number of integer digits
`static NumberFormatter`	`oneDigit` Predefined NumberFormatter for #
`protected char`	`separator` Separates groups of 3 digits
`protected boolean`	`showPosSign` TRUE if positive sign shall be displayed
`static NumberFormatter`	`sixDigits` Predefined NumberFormatter for ######
`static NumberFormatter`	`threeDigits` Predefined NumberFormatter for ###
`static NumberFormatter`	`twoDigits` Predefined NumberFormatter for ##
`static NumberFormatter`	`twoFractions` Predefined NumberFormatter for #.##

Constructor Summary

Constructors
Constructor and Description

NumberFormatter(String f)
Creates a NumberFormatter for a pattern

Constructors
Constructor and Description
`NumberFormatter(String f)` Creates a NumberFormatter for a pattern

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`format(double d)` Converts a double to a String
`static String`	`formatMS(long ms)` Converts milliseconds to a nice String
`static String`	`ISOdate()` Returns an ISO8601 string representation of the current date
`static String`	`ISOdate(Calendar c)` Returns an ISO8601 string representation of the time given by the calendar
`static String`	`ISOtime()` Returns an ISO8601 string representation of the current time
`static String`	`ISOtime(Calendar c)` Returns an ISO8601 string representation of the time given by the calendar
`static String`	`ISOweekTime()` Returns an ISO8601 string representation of the current time, using a week-oriented representation
`static String`	`ISOweekTime(Calendar c)` Returns an ISO8601 string representation of the time given by the calendar, using a week-oriented representation
`static void`	`main(String[] argv)` Test routine
`static String`	`timeStamp()` Returns a current timestamp
`static String`	`timeStamp(Calendar c)` Returns a timestamp from a Calendar
`static String`	`timeStamp(String isoTime)` Returns a timestamp from an ISOweekTime or an ISOtime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - integers
```
protected int integers
```
    Holds the number of integer digits
  - fractions
```
protected int fractions
```
    Holds the number of fraction digits
  - showPosSign
```
protected boolean showPosSign
```
    TRUE if positive sign shall be displayed
  - separator
```
protected char separator
```
    Separates groups of 3 digits
  - FORMAT
```
protected Pattern FORMAT
```
    Pattern for the pattern string
  - append
```
protected String append
```
    What shall be appended
  - sixDigits
```
public static NumberFormatter sixDigits
```
    Predefined NumberFormatter for ######
  - fiveDigits
```
public static NumberFormatter fiveDigits
```
    Predefined NumberFormatter for #####
  - fourDigits
```
public static NumberFormatter fourDigits
```
    Predefined NumberFormatter for ####
  - threeDigits
```
public static NumberFormatter threeDigits
```
    Predefined NumberFormatter for ###
  - twoDigits
```
public static NumberFormatter twoDigits
```
    Predefined NumberFormatter for ##
  - oneDigit
```
public static NumberFormatter oneDigit
```
    Predefined NumberFormatter for #
  - fourFractions
```
public static NumberFormatter fourFractions
```
    Predefined NumberFormatter for #.####
  - twoFractions
```
public static NumberFormatter twoFractions
```
    Predefined NumberFormatter for #.##
- Constructor Detail
  - NumberFormatter
```
public NumberFormatter(String f)
```
    Creates a NumberFormatter for a pattern
- Method Detail
  - format
```
public String format(double d)
```
    Converts a double to a String
  - ISOtime
```
public static String ISOtime()
```
    Returns an ISO8601 string representation of the current time
  - ISOtime
```
public static String ISOtime(Calendar c)
```
    Returns an ISO8601 string representation of the time given by the calendar
  - ISOdate
```
public static String ISOdate()
```
    Returns an ISO8601 string representation of the current date
  - ISOdate
```
public static String ISOdate(Calendar c)
```
    Returns an ISO8601 string representation of the time given by the calendar
  - ISOweekTime
```
public static String ISOweekTime()
```
    Returns an ISO8601 string representation of the current time, using a week-oriented representation
  - ISOweekTime
```
public static String ISOweekTime(Calendar c)
```
    Returns an ISO8601 string representation of the time given by the calendar, using a week-oriented representation
  - timeStamp
```
public static String timeStamp(String isoTime)
```
    Returns a timestamp from an ISOweekTime or an ISOtime
  - timeStamp
```
public static String timeStamp(Calendar c)
```
    Returns a timestamp from a Calendar
  - timeStamp
```
public static String timeStamp()
```
    Returns a current timestamp
  - formatMS
```
public static String formatMS(long ms)
```
    Converts milliseconds to a nice String
  - main
```
public static void main(String[] argv)
```
    Test routine

Class NumberFormatter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

integers

fractions

showPosSign

separator

FORMAT

append

sixDigits

fiveDigits

fourDigits

threeDigits

twoDigits

oneDigit

fourFractions

twoFractions

Constructor Detail

NumberFormatter

Method Detail

format

ISOtime

ISOtime

ISOdate

ISOdate

ISOweekTime

ISOweekTime

timeStamp

timeStamp

timeStamp

formatMS

main