Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.joda.time.format

Interface PeriodPrinter

public interface PeriodPrinter
Internal interface for printing textual representations of time periods.

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

The factory classes are:
- PeriodFormatterBuilder
- PeriodFormat
- ISOPeriodFormat

Authors:
Brian S O'Neill
Stephen Colebourne
Since:
1.0
See Also:
PeriodFormatter, PeriodFormatterBuilder, PeriodFormat

Method Summary

int
calculatePrintedLength(ReadablePeriod period, Locale locale)
Returns the exact number of characters produced for the given period.
int
countFieldsToPrint(ReadablePeriod period, int stopAt, Locale locale)
Returns the amount of fields from the given period that this printer will print.
void
printTo(StringBuffer buf, ReadablePeriod period, Locale locale)
Prints a ReadablePeriod to a StringBuffer.
void
printTo(Writer out, ReadablePeriod period, Locale locale)
Prints a ReadablePeriod to a Writer.

Method Details

calculatePrintedLength

public int calculatePrintedLength(ReadablePeriod period,
                                  Locale locale)
Returns the exact number of characters produced for the given period.
Parameters:
period - the period to use
locale - the locale to use
Returns:
the estimated length

countFieldsToPrint

public int countFieldsToPrint(ReadablePeriod period,
                              int stopAt,
                              Locale locale)
Returns the amount of fields from the given period that this printer will print.
Parameters:
period - the period to use
stopAt - stop counting at this value, enter a number ≥ 256 to count all
locale - the locale to use
Returns:
amount of fields printed

printTo

public void printTo(StringBuffer buf,
                    ReadablePeriod period,
                    Locale locale)
Prints a ReadablePeriod to a StringBuffer.
Parameters:
buf - the formatted period is appended to this buffer
period - the period to format
locale - the locale to use

printTo

public void printTo(Writer out,
                    ReadablePeriod period,
                    Locale locale)
            throws IOException
Prints a ReadablePeriod to a Writer.
Parameters:
out - the formatted period is written out
period - the period to format
locale - the locale to use

Overview Package Class Use Tree Index Deprecated About
Copyright (c) 2001-2006 - Joda.org