js.format

Class DateTimeFormat

java.lang.Object

js.format.DateTimeFormat

All Implemented Interfaces:

Format

Direct Known Subclasses:

FullDate, FullDateTime, FullTime, LongDate, LongDateTime, LongTime, MediumDate, MediumDateTime, MediumTime, ShortDate, ShortDateTime, ShortTime, StandardDate, StandardDateTime, StandardTime

public abstract class DateTimeFormat
extends Object
implements Format

Base class for all date/time formatters. This abstract base class implements almost entire date time formatting logic. Concrete implementation should only implement the factory method 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);
   }
 }
 

In order to use date time formatter one should create formatter instance - with default locale and time zone, optionally set new locale settings and / or time zone then execute format.

 DateTimeFormat formatter = new FullDateTime();
 formatter.setLocale(new Locale("ro"));
 formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
 
 String dateDisplay = formatter.format(new Date());
 

All date time formatters uses Java DateFormat for actual format. Since Java DateFormat is not synchronized date time formatter instances are not thread safe. Anyway, inside a thread, formatter instances can be reused.

Version:

final

Author:

Iulian Rotaru

Field Summary

Fields

Modifier and Type	Field and Description
private DateFormat	dateFormat Date format instance in charge with actual formatting.
private Locale	locale Formatter locale settings.
private TimeZone	timeZone Formatter date time zone.

Constructor Summary

Constructors

Constructor and Description
DateTimeFormat() Construct date time formatter with default locale settings and time zone.

Method Summary

Modifier and Type	Method and Description
protected abstract DateFormat	createDateFormat(Locale locale) Factory method for date time formatter instance.
String	format(Object date) Format date object accordingly concrete date time formatter implementation.
Object	parse(String value) Parse date value and return Date instance.
void	setLocale(Locale locale) Set locale settings for this formatter instance.
void	setTimeZone(TimeZone timeZone) Set time zone for this date time formatter instance.

Methods inherited from class java.lang.Object

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

Field Detail

locale

private Locale locale

Formatter locale settings.

timeZone

private TimeZone timeZone

Formatter date time zone.

dateFormat

private DateFormat dateFormat

Date format instance in charge with actual formatting.

Constructor Detail

DateTimeFormat

public DateTimeFormat()

Construct date time formatter with default locale settings and time zone.

Method Detail

createDateFormat

protected abstract DateFormat createDateFormat(Locale locale)

Factory method for date time formatter instance.

Parameters:

locale - locale settings.

Returns:

newly created date time formatter.

setLocale

public void setLocale(Locale locale)

Set locale settings for this formatter instance. Given locale settings overwrites default value initialized by constructor. For this setter to have effect it should be called before invoking format(Object).

Parameters:

locale - locale settings.

setTimeZone

public void setTimeZone(TimeZone timeZone)

Set time zone for this date time formatter instance. Given time zone overwrites default time zone initialized by constructor. For this setter to have effect it should be called before invoking format(Object).

Parameters:

timeZone - time zone.

format

public String format(Object date)

Format date object accordingly concrete date time formatter implementation. Formatting process occurs in three steps:

1. create date time formatter instance with current locale, see createDateFormat(Locale),
2. set current time zone to newly created formatter instance,
3. invoke Format.format(Object) on formatter instance.

Returns empty string if given date instance is null.

Specified by:

format in interface Format

Parameters:

date - date object.

Returns:

string format for date argument or empty string if date is null.

parse

public Object parse(String value)
             throws ParseException

Parse date value and return Date instance. Given value should encode a date instance accordingly this formatter locale. Returns null if value argument is null or empty.

Specified by:

parse in interface Format

Parameters:

value - date localized value.

Returns:

Date instance or null if value argument is null or empty.

Throws:

ParseException - if value argument is not a valid date accordingly this formatter locale.