org.joda.time.format
Interface DateTimePrinter


public interface DateTimePrinter

Internal interface for creating textual representations of datetimes.

Application users will rarely use this class directly. Instead, you will use one of the factory classes to create a DateTimeFormatter.

The factory classes are:
- DateTimeFormatterBuilder
- DateTimeFormat
- ISODateTimeFormat

Since:
1.0
Author:
Brian S O'Neill, Stephen Colebourne
See Also:
DateTimeFormatterBuilder, DateTimeFormat, ISODateTimeFormat

Method Summary
 int estimatePrintedLength()
          Returns the expected maximum number of characters produced.
 void printTo(StringBuffer buf, long instant, Chronology chrono, int displayOffset, DateTimeZone displayZone, Locale locale)
          Prints an instant from milliseconds since 1970-01-01T00:00:00Z, using the given Chronology.
 void printTo(StringBuffer buf, ReadablePartial partial, Locale locale)
          Prints a ReadablePartial.
 void printTo(Writer out, long instant, Chronology chrono, int displayOffset, DateTimeZone displayZone, Locale locale)
          Prints an instant from milliseconds since 1970-01-01T00:00:00Z, using the given Chronology.
 void printTo(Writer out, ReadablePartial partial, Locale locale)
          Prints a ReadablePartial.
 

Method Detail

estimatePrintedLength

int estimatePrintedLength()
Returns the expected maximum number of characters produced. The actual amount should rarely exceed this estimate.

Returns:
the estimated length

printTo

void printTo(StringBuffer buf,
             long instant,
             Chronology chrono,
             int displayOffset,
             DateTimeZone displayZone,
             Locale locale)
Prints an instant from milliseconds since 1970-01-01T00:00:00Z, using the given Chronology.

Parameters:
buf - formatted instant is appended to this buffer, not null
instant - millis since 1970-01-01T00:00:00Z
chrono - the chronology to use, not null
displayOffset - if a time zone offset is printed, force it to use this millisecond value
displayZone - the time zone to use, null means local time
locale - the locale to use, null means default locale

printTo

void printTo(Writer out,
             long instant,
             Chronology chrono,
             int displayOffset,
             DateTimeZone displayZone,
             Locale locale)
             throws IOException
Prints an instant from milliseconds since 1970-01-01T00:00:00Z, using the given Chronology.

Parameters:
out - formatted instant is written out
instant - millis since 1970-01-01T00:00:00Z
chrono - the chronology to use, not null
displayOffset - if a time zone offset is printed, force it to use this millisecond value
displayZone - the time zone to use, null means local time
locale - the locale to use, null means default locale
Throws:
IOException

printTo

void printTo(StringBuffer buf,
             ReadablePartial partial,
             Locale locale)
Prints a ReadablePartial.

Parameters:
buf - formatted partial is appended to this buffer, not null
partial - partial to format, not null
locale - the locale to use, null means default locale

printTo

void printTo(Writer out,
             ReadablePartial partial,
             Locale locale)
             throws IOException
Prints a ReadablePartial.

Parameters:
out - formatted partial is written out, not null
partial - partial to format, not null
locale - the locale to use, null means default locale
Throws:
IOException


Copyright © 2002-2013 Joda.org. All Rights Reserved.