Package org.apache.commons.lang3.time
Interface DatePrinter
-
- All Known Implementing Classes:
FastDateFormat,FastDatePrinter
public interface DatePrinter
DatePrinter is the "missing" interface for the format methods ofDateFormat. 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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Stringformat(long millis)Formats a millisecondlongvalue.<B extends Appendable>
Bformat(long millis, B buf)Formats a millisecondlongvalue into the suppliedAppendable.StringBufferformat(long millis, StringBuffer buf)Deprecated.Use {format(long, Appendable).StringBufferformat(Object obj, StringBuffer toAppendTo, FieldPosition pos)Stringformat(Calendar calendar)Formats aCalendarobject.<B extends Appendable>
Bformat(Calendar calendar, B buf)Formats aCalendarobject into the suppliedAppendable.StringBufferformat(Calendar calendar, StringBuffer buf)Deprecated.Stringformat(Date date)Formats aDateobject using aGregorianCalendar.<B extends Appendable>
Bformat(Date date, B buf)StringBufferformat(Date date, StringBuffer buf)Deprecated.Use {format(Date, Appendable).LocalegetLocale()Gets the locale used by this printer.StringgetPattern()Gets the pattern used by this printer.TimeZonegetTimeZone()Gets the time zone used by this printer.
-
-
-
Method Detail
-
format
String format(long millis)
Formats a millisecondlongvalue.- Parameters:
millis- the millisecond value to format- Returns:
- the formatted string
- Since:
- 2.1
-
format
String format(Date date)
Formats aDateobject using aGregorianCalendar.- Parameters:
date- the date to format- Returns:
- the formatted string
-
format
String format(Calendar calendar)
Formats aCalendarobject. 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
-
format
@Deprecated StringBuffer format(long millis, StringBuffer buf)
Deprecated.Use {format(long, Appendable).Formats a millisecondlongvalue into the suppliedStringBuffer.- Parameters:
millis- the millisecond value to formatbuf- the buffer to format into- Returns:
- the specified string buffer
-
format
@Deprecated StringBuffer format(Date date, StringBuffer buf)
Deprecated.Use {format(Date, Appendable).- Parameters:
date- the date to formatbuf- the buffer to format into- Returns:
- the specified string buffer
-
format
@Deprecated StringBuffer format(Calendar calendar, StringBuffer buf)
Deprecated.Formats aCalendarobject into the suppliedStringBuffer. 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 formatbuf- the buffer to format into- Returns:
- the specified string buffer
-
format
<B extends Appendable> B format(long millis, B buf)
Formats a millisecondlongvalue into the suppliedAppendable.- Type Parameters:
B- the Appendable class type, usually StringBuilder or StringBuffer.- Parameters:
millis- the millisecond value to formatbuf- the buffer to format into- Returns:
- the specified string buffer
- Since:
- 3.5
-
format
<B extends Appendable> B format(Date date, B buf)
- Type Parameters:
B- the Appendable class type, usually StringBuilder or StringBuffer.- Parameters:
date- the date to formatbuf- the buffer to format into- Returns:
- the specified string buffer
- Since:
- 3.5
-
format
<B extends Appendable> B format(Calendar calendar, B buf)
Formats aCalendarobject into the suppliedAppendable. 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.- Type Parameters:
B- the Appendable class type, usually StringBuilder or StringBuffer.- Parameters:
calendar- the calendar to formatbuf- the buffer to format into- Returns:
- the specified string buffer
- Since:
- 3.5
-
getPattern
String getPattern()
Gets the pattern used by this printer.- Returns:
- the pattern,
SimpleDateFormatcompatible
-
getTimeZone
TimeZone getTimeZone()
Gets the time zone used by this printer.This zone is always used for
Dateprinting.- Returns:
- the time zone
-
format
StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
- Parameters:
obj- the object to formattoAppendTo- the buffer to append topos- the position - ignored- Returns:
- the buffer passed in
- See Also:
DateFormat.format(Object, StringBuffer, FieldPosition)
-
-