Package js.format

User interface formatters and parsers.

See: Description

Interface Summary

Interface	Description
Format	Format or parse object value as/from string suitable for user interfaces.

Class Summary

Class	Description
BitRate	Bit rate format - 12.30 Kbps.
Currency	Currency format - $12.34.
DateTimeFormat	Base class for all date/time formatters.
Duration	Format duration value, in milliseconds - 12.30 min.
FileSize	File size format - 12.30 KB.
FullDate	Full date format - Sunday, March 15, 1964.
FullDateTime	Full date/time format - Sunday, March 15, 1964 11:40:00 AM UTC.
FullTime	Full time format - 11:40:00 AM UTC.
LongDate	Long date format - March 15, 1964.
LongDateTime	Long date/time format - March 15, 1964 11:40:00 AM UTC.
LongTime	Long time format - 11:40:00 AM UTC.
MediumDate	Medium date format - Mar 15, 1964.
MediumDateTime	Medium date/time format - Mar 15, 1964 11:40:00 AM.
MediumTime	Medium time format - 11:40:00 AM.
Number	Numeric value format - 12.34.
Percent	Percent value format - 12.34%.
ShortDate	Short date format - 3/15/64.
ShortDateTime	Short date/time format - 3/15/64 11:40 AM.
ShortTime	Short time format - 11:40 AM.
StandardDate	Standard date format - 1964-03-15
StandardDateTime	Standard date time format - 1964-03-15 14:30:00
StandardTime	Standard time format - 14:30:00
TestDateTime	Test utility class for dates parsing and formatting in standard date time.

Enum Summary

Enum	Description
BitRate.Units	Bit rate measurement units.
Duration.Units	Duration measurement units.
FileSize.Units	File size measurement units.

Package js.format Description

User interface formatters and parsers. Format package convert object values to/from string representation usable to user interfaces. Formatted string should be proper for display on user interfaces and may be subject to locale and time zone adjustments. Note that not all format classes should be both locale and time zone sensitive.

A formatter deals with object value. An object value is an instance of a class that wrap a single value susceptible to be represented as a single string - a sort of data atom, e.g. java.io.File or java.net.URL.

Stock Format Classes

Format package contains ready to use format classes for date/time, currency, percent, numbers and file size. Here is a list with sample output/input to help decide which best fit your needs.

Value Sample

Class	English Sample	Romanian Sample
FullDateTime	Sunday, March 15, 1964 11:40:00 AM UTC	15 martie 1964 11:40:00 UTC
FullDate	Sunday, March 15, 1964	15 martie 1964
FullTime	11:40:00 AM UTC	11:40:00 UTC
LongDateTime	March 15, 1964 11:40:00 AM UTC	15 martie 1964 11:40:00 UTC
LongDate	March 15, 1964	15 martie 1964
LongTime	11:40:00 AM UTC	11:40:00 UTC
MediumDateTime	Mar 15, 1964 11:40:00 AM	15.03.1964 11:40:00
MediumDate	Mar 15, 1964	15.03.1964
MediumTime	11:40:00 AM	11:40:00
ShortDateTime	3/15/64 11:40 AM	15.03.1964 11:40
ShortDate	3/15/64	15.03.1964
ShortTime	11:40 AM	11:40
StandardDateTime	1964-03-15 14:30:00	1964-03-15 14:30:00
StandardDate	1964-03-15	1964-03-15
StandardTime	14:30:00	14:30:00
Currency	$12.34	12,34 LEI
Percent	12.34%	12,34%
Number	12.34	12,34
FileSize	2.34KB	2,34KB

Usage

In order to invoke Format.format(Object) or Format.parse(String) one needs a formatter instance. If a formatter is locale and or time zone sensitive its constructor takes care to initialize default values. Formatter implementation may provide setters for locale settings and time zone used to overwrite default values. If present, these setters should be called before executing formatting or parsing. Here is a sample usage on a date time formatter.

 LongDate formatter = new LongDate();
 formatter.setLocale(new Locale("ro"));
 formatter.setTimeZone(TimeZone.getTimeZone("EET"));
 ...
 System.out.println(formatter.format(new Date()));
 

User Defined Formatters

For formatters not related to date there is no much support. Custom formatter should only implement Format interface.

For date time formatters, format package provides an abstract base class. This abstract base class implements almost entire date time formatting and parsing logic. User defined implementation should only implement the factory method DateTimeFormat.createDateFormat(Locale).

For your convenience here is an example of a date time formatter from this package.

 public final class StandardDateTime extends DateTimeFormat {
        private static final String STANDARD_FORMAT = "yyyy-MM-dd HH:mm:ss";
 
        @Override
        protected DateFormat createDateFormat(Locale locale) {
                return new SimpleDateFormat(STANDARD_FORMAT, locale);
        }
 }
 

Version:

final

Author:

Iulian Rotaru