Copy as Markdown

On this page

DatePrinter

public abstract interface org.apache.commons.lang3.time.DatePrinter

DatePrinter is the “missing” interface for the format methods of java.text.DateFormat. You can obtain an object implementing this interface by using one of the FastDateFormat factory methods.

Warning: Since binary compatible methods may be added to this interface in any release, developers are not expected to implement this interface.

Since:

3.2

Methods

format(Object, StringBuffer, FieldPosition)	Formats a Date, Calendar or Long (milliseconds) object.
format(Calendar)	Formats a Calendar object.
format(Calendar, Appendable)	Formats a Calendar object into the supplied Appendable.
format(Calendar, StringBuffer)	Deprecated. Formats a Calendar object into the supplied StringBuffer.
format(Date)	Formats a Date object using a GregorianCalendar.
format(Date, Appendable)	Formats a Date object into the supplied Appendable using a GregorianCalendar.
format(Date, StringBuffer)	Deprecated. Formats a Date object into the supplied StringBuffer using a GregorianCalendar.
format(long)	Formats a millisecond long value.
format(long, Appendable)	Formats a millisecond long value into the supplied Appendable.
format(long, StringBuffer)	Deprecated. Formats a millisecond long value into the supplied StringBuffer.
getLocale()	Gets the locale used by this printer.
getPattern()	Gets the pattern used by this printer.
getTimeZone()	Gets the time zone used by this printer.

public abstract StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)

Formats a Date, Calendar or Long (milliseconds) object.

Parameters:

• obj – The object to format.

• toAppendTo – The buffer to append to.

• pos – The position - ignored.

Returns:

The buffer passed in.

See also:

java.text.DateFormat#format(Object, StringBuffer, FieldPosition)

public abstract String format(Calendar calendar)

Formats a Calendar object. The TimeZone set on the Calendar is only used to adjust the time offset. The TimeZone specified during the construction of the Parser will determine the TimeZone used in the formatted string.

Parameters:

calendar – The calendar to format.

Returns:

The formatted string.

public abstract <B extends Appendable> B format(Calendar calendar, B buf)

Formats a Calendar object into the supplied Appendable. The TimeZone set on the Calendar is only used to adjust the time offset. The TimeZone specified during the construction of the Parser will determine the TimeZone used in the formatted string.

Parameters:

• calendar – The calendar to format.

• buf – The buffer to format into.

Type parameters:

<B> – The Appendable class type, usually StringBuilder or StringBuffer.

Returns:

The specified string buffer.

Since:

3.5

@Deprecated public abstract StringBuffer format(Calendar calendar, StringBuffer buf)

Deprecated: Use {#format(Calendar, Appendable).

Formats a Calendar object into the supplied StringBuffer. The TimeZone set on the Calendar is only used to adjust the time offset. The TimeZone specified during the construction of the Parser will determine the TimeZone used in the formatted string.

Parameters:

• calendar – The calendar to format.

• buf – The buffer to format into.

Returns:

The specified string buffer.

public abstract String format(Date date)

Formats a Date object using a GregorianCalendar.

Parameters:

date – The date to format

Returns:

The formatted string

public abstract <B extends Appendable> B format(Date date, B buf)

Formats a Date object into the supplied Appendable using a GregorianCalendar.

Parameters:

• date – The date to format.

• buf – The buffer to format into.

Type parameters:

<B> – The Appendable class type, usually StringBuilder or StringBuffer.

Returns:

The specified string buffer.

Since:

3.5

@Deprecated public abstract StringBuffer format(Date date, StringBuffer buf)

Deprecated: Use {#format(Date, Appendable).

Formats a Date object into the supplied StringBuffer using a GregorianCalendar.

Parameters:

• date – The date to format.

• buf – The buffer to format into.

Returns:

The specified string buffer.

public abstract String format(long millis)

Formats a millisecond long value.

Parameters:

millis – The millisecond value to format.

Returns:

The formatted string.

Since:

2.1

public abstract <B extends Appendable> B format(long millis, B buf)

Formats a millisecond long value into the supplied Appendable.

Parameters:

• millis – The millisecond value to format.

• buf – The buffer to format into.

Type parameters:

<B> – The Appendable class type, usually StringBuilder or StringBuffer.

Returns:

The specified string buffer.

Since:

3.5

@Deprecated public abstract StringBuffer format(long millis, StringBuffer buf)

Deprecated: Use {#format(long, Appendable).

Formats a millisecond long value into the supplied StringBuffer.

Parameters:

• millis – The millisecond value to format.

• buf – The buffer to format into.

Returns:

The specified string buffer.

public abstract Locale getLocale()

Gets the locale used by this printer.

Returns:

The locale.

public abstract String getPattern()

Gets the pattern used by this printer.

Returns:

The pattern, java.text.SimpleDateFormat compatible.

public abstract TimeZone getTimeZone()

Gets the time zone used by this printer.

This zone is always used for Date printing.

Returns:

The time zone.