org.pojava.datetime

Class DateTimeFormat

java.lang.Object

org.pojava.datetime.DateTimeFormat

public class DateTimeFormat
extends Object

DateTimeFormat formats a DateTime object as a String according to a template. This class provides similar functionality to Java's SimpleDateFormat class, with some notable differences. It changes the meaning of the "S" character from "millisecond" to "fractional second" so that, for example, nine consecutive "S" characters would represent nanoseconds, while three "S" characters represent milliseconds. The upper-case "G" still represents "BC" or "AD", but I added a lower-cased "g" to the format to use "BCE" or "CE". While "Z" still shows time zone offset as "-HHmm", "ZZ" will add a colon, as "-HH:mm".

Because it does not "compile" the format String, DateTimeFormat can provide a static method with the same performance as a constructed object. It does allow a constructed object for similar behavior to existing formatters, but there is no performance advantage in doing so. In either case, this class is thread-safe, provided your application is not trying to change the internals of Java's TimeZone object as you're using it.

It is important to understand that the default behavior is to format the output according to the system's time zone. If you want to format the output according to the DateTime object's internal time zone, then pass the time zone as a parameter. For example,

 DateTimeFormat("yyyy-MM-dd", dateTimeObj, dateTimeObj.getTimezone);
 

For this version, you're kind of stuck with an English-only version of dates. I'll be revising that at a future date.

Author:

John Pile

Constructor Summary

Constructors

Constructor and Description
DateTimeFormat(String template)

Method Summary

Methods

Modifier and Type	Method and Description
String	format(DateTime dt)
String	format(long millis)
static String	format(String template, DateTime dt)
static String	format(String template, DateTime dt, TimeZone tz)
static String	format(String template, DateTime dt, TimeZone tz, Locale locale)
static String	format(String template, long millis)

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeFormat

public DateTimeFormat(String template)

Parameters:

template - Format specifier

Method Detail

format

public String format(DateTime dt)

Parameters:

dt - Format the given DateTime value to a String

Returns:

Formatted output

format

public String format(long millis)

Parameters:

millis - Format the given millis value to a String

Returns:

Formatted output

format

public static String format(String template,
            long millis)

Parameters:

template - Template under which the output is formatted

millis - Format the given millis value to a String

Returns:

Formatted output

format

public static String format(String template,
            DateTime dt)

Parameters:

template - Template under which the output is formatted

dt - Format the given DateTime value to a String

Returns:

Formatted output

format

public static String format(String template,
            DateTime dt,
            TimeZone tz)

Parameters:

template - Template under which the output is formatted

dt - Format the given DateTime value to a String

tz - TimeZone for which the output is displayed

Returns:

Formatted output

format

public static String format(String template,
            DateTime dt,
            TimeZone tz,
            Locale locale)

Parameters:

template - Template under which the output is formatted

dt - Format the given DateTime value to a String

tz - TimeZone for which the output is displayed

locale - Locale governing language of non-numeric output

Returns:

Formatted output