Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
 /*
  *  Copyright 2001-2005 Stephen Colebourne
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.joda.time.format;
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

Author(s):
Brian S O'Neill
Stephen Colebourne
Since:
1.0
See also:
PeriodFormatter
PeriodFormatterBuilder
PeriodFormat
public interface PeriodPrinter {

    
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
    int calculatePrintedLength(ReadablePeriod periodLocale 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
    int countFieldsToPrint(ReadablePeriod periodint stopAtLocale 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
    void printTo(StringBuffer bufReadablePeriod periodLocale locale);

    
Prints a ReadablePeriod to a Writer.

Parameters:
out the formatted period is written out
period the period to format
locale the locale to use
    void printTo(Writer outReadablePeriod periodLocale localethrows IOException;
New to GrepCode? Check out our FAQ X