Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.joda.time.format.PeriodFormatterBuilder
public class PeriodFormatterBuilder
extends java.lang.Object
PeriodFormatter
class.
Three classes provide factory methods to create formatters, and this is one.
The others are PeriodFormat
and ISOPeriodFormat
.
PeriodFormatterBuilder is used for constructing formatters which are then
used to print or parse. The formatters are built by appending specific fields
or other formatters to an instance of this builder.
For example, a formatter that prints years and months, like "15 years and 8 months",
can be constructed as follows:
PeriodFormatter yearsAndMonths = new PeriodFormatterBuilder() .printZeroAlways() .appendYears() .appendSuffix(" year", " years") .appendSeparator(" and ") .printZeroRarely() .appendMonths() .appendSuffix(" month", " months") .toFormatter();PeriodFormatterBuilder itself is mutable and not thread-safe, but the formatters that it builds are thread-safe and immutable.
PeriodFormat
Constructor Summary | |
Method Summary | |
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
void |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatterBuilder |
|
PeriodFormatter |
|
PeriodParser |
|
PeriodPrinter |
|
public PeriodFormatterBuilder append(PeriodFormatter formatter)
Appends another formatter.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder append(PeriodPrinter printer, PeriodParser parser)
Appends a printer parser pair. Either the printer or the parser may be null, in which case the builder will be unable to produce a parser or printer repectively.
- Parameters:
printer
- appends a printer to the builder, null if printing is not supportedparser
- appends a parser to the builder, null if parsing is not supported
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendDays()
Instruct the printer to emit an integer days field, if supported. The number of printed and parsed digits can be controlled usingminimumPrintedDigits(int)
andmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendHours()
Instruct the printer to emit an integer hours field, if supported. The number of printed and parsed digits can be controlled usingminimumPrintedDigits(int)
andmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendLiteral(String text)
Instructs the printer to emit specific text, and the parser to expect it. The parser is case-insensitive.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendMillis()
Instruct the printer to emit an integer millis field, if supported. The number of printed and parsed digits can be controlled usingminimumPrintedDigits(int)
andmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendMillis3Digit()
Instruct the printer to emit an integer millis field, if supported. The number of arsed digits can be controlled usingmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendMinutes()
Instruct the printer to emit an integer minutes field, if supported. The number of printed and parsed digits can be controlled usingminimumPrintedDigits(int)
andmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendMonths()
Instruct the printer to emit an integer months field, if supported. The number of printed and parsed digits can be controlled usingminimumPrintedDigits(int)
andmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendPrefix(String text)
Append a field prefix which applies only to the next appended field. If the field is not printed, neither is the prefix.
- Parameters:
text
- text to print before field only if field is printed
- Returns:
- this PeriodFormatterBuilder
- See Also:
appendSuffix
public PeriodFormatterBuilder appendPrefix(String singularText, String pluralText)
Append a field prefix which applies only to the next appended field. If the field is not printed, neither is the prefix. During parsing, the singular and plural versions are accepted whether or not the actual value matches plurality.
- Parameters:
singularText
- text to print if field value is onepluralText
- text to print if field value is not one
- Returns:
- this PeriodFormatterBuilder
- See Also:
appendSuffix
public PeriodFormatterBuilder appendSeconds()
Instruct the printer to emit an integer seconds field, if supported. The number of printed and parsed digits can be controlled usingminimumPrintedDigits(int)
andmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendSecondsWithMillis()
Instruct the printer to emit a combined seconds and millis field, if supported. The millis will overflow into the seconds if necessary. The millis are always output.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendSecondsWithOptionalMillis()
Instruct the printer to emit a combined seconds and millis field, if supported. The millis will overflow into the seconds if necessary. The millis are only output if non-zero.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendSeparator(String text)
Append a separator, which is output if fields are printed both before and after the separator. For example,builder.appendDays().appendSeparator(",").appendHours()
will only output the comma if both the days and hours fields are output. The text will be parsed case-insensitively. Note: appending a separator discontinues any further work on the latest appended field.
- Parameters:
text
- the text to use as a separator
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendSeparator(String text, String finalText)
Append a separator, which is output if fields are printed both before and after the separator. This method changes the separator depending on whether it is the last separator to be output. For example,builder.appendDays().appendSeparator(",", "&").appendHours().appendSeparator(",", "&").appendMinutes()
will output '1,2&3' if all three fields are output, '1&2' if two fields are output and '1' if just one field is output. The text will be parsed case-insensitively. Note: appending a separator discontinues any further work on the latest appended field.
- Parameters:
text
- the text to use as a separatorfinalText
- the text used used if this is the final separator to be printed
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendSeparator(String text, String finalText, String[] variants)
Append a separator, which is output if fields are printed both before and after the separator. This method changes the separator depending on whether it is the last separator to be output. For example,builder.appendDays().appendSeparator(",", "&").appendHours().appendSeparator(",", "&").appendMinutes()
will output '1,2&3' if all three fields are output, '1&2' if two fields are output and '1' if just one field is output. The text will be parsed case-insensitively. Note: appending a separator discontinues any further work on the latest appended field.
- Parameters:
text
- the text to use as a separatorfinalText
- the text used used if this is the final separator to be printedvariants
- set of text values which are also acceptable when parsed
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendSeparatorIfFieldsAfter(String text)
Append a separator, which is output only if fields are printed after the separator. For example,builder.appendDays().appendSeparatorIfFieldsAfter(",").appendHours()
will only output the comma if the hours fields is output. The text will be parsed case-insensitively. Note: appending a separator discontinues any further work on the latest appended field.
- Parameters:
text
- the text to use as a separator
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendSeparatorIfFieldsBefore(String text)
Append a separator, which is output only if fields are printed before the separator. For example,builder.appendDays().appendSeparatorIfFieldsBefore(",").appendHours()
will only output the comma if the days fields is output. The text will be parsed case-insensitively. Note: appending a separator discontinues any further work on the latest appended field.
- Parameters:
text
- the text to use as a separator
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendSuffix(String text)
Append a field suffix which applies only to the last appended field. If the field is not printed, neither is the suffix.
- Parameters:
text
- text to print after field only if field is printed
- Returns:
- this PeriodFormatterBuilder
- See Also:
appendPrefix
public PeriodFormatterBuilder appendSuffix(String singularText, String pluralText)
Append a field suffix which applies only to the last appended field. If the field is not printed, neither is the suffix. During parsing, the singular and plural versions are accepted whether or not the actual value matches plurality.
- Parameters:
singularText
- text to print if field value is onepluralText
- text to print if field value is not one
- Returns:
- this PeriodFormatterBuilder
- See Also:
appendPrefix
public PeriodFormatterBuilder appendWeeks()
Instruct the printer to emit an integer weeks field, if supported. The number of printed and parsed digits can be controlled usingminimumPrintedDigits(int)
andmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder appendYears()
Instruct the printer to emit an integer years field, if supported. The number of printed and parsed digits can be controlled usingminimumPrintedDigits(int)
andmaximumParsedDigits(int)
.
- Returns:
- this PeriodFormatterBuilder
public void clear()
Clears out all the appended elements, allowing this builder to be reused.
public PeriodFormatterBuilder maximumParsedDigits(int maxDigits)
Set the maximum digits parsed for the next and following appended fields. By default, the maximum digits parsed is ten.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder minimumPrintedDigits(int minDigits)
Set the minimum digits printed for the next and following appended fields. By default, the minimum digits printed is one. If the field value is zero, it is not printed unless a printZero rule is applied.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder printZeroAlways()
Always print zero values for the next and following appended fields, even if the period doesn't support it. The parser requires values for fields that always print zero.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder printZeroIfSupported()
Print zero values for the next and following appened fields only if the period supports it.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder printZeroNever()
Never print zero values for the next and following appended fields, unless no fields would be printed. If no fields are printed, the printer forces the last "printZeroRarely" field to print a zero. This field setting is the default.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder printZeroRarelyFirst()
Never print zero values for the next and following appended fields, unless no fields would be printed. If no fields are printed, the printer forces the first "printZeroRarely" field to print a zero.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder printZeroRarelyLast()
Never print zero values for the next and following appended fields, unless no fields would be printed. If no fields are printed, the printer forces the last "printZeroRarely" field to print a zero. This field setting is the default.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatterBuilder rejectSignedValues(boolean v)
Reject signed values when parsing the next and following appended fields.
- Returns:
- this PeriodFormatterBuilder
public PeriodFormatter toFormatter()
Constructs a PeriodFormatter using all the appended elements. This is the main method used by applications at the end of the build process to create a usable formatter. Subsequent changes to this builder do not affect the returned formatter. The returned formatter may not support both printing and parsing. The methodsPeriodFormatter.isPrinter()
andPeriodFormatter.isParser()
will help you determine the state of the formatter.
- Returns:
- the newly created formatter
public PeriodParser toParser()
Internal method to create a PeriodParser instance using all the appended elements. Most applications will not use this method. If you want a printer in an application, calltoFormatter()
and just use the printing API. Subsequent changes to this builder do not affect the returned parser.
- Returns:
- the newly created parser, null if builder cannot create a parser
public PeriodPrinter toPrinter()
Internal method to create a PeriodPrinter instance using all the appended elements. Most applications will not use this method. If you want a printer in an application, calltoFormatter()
and just use the printing API. Subsequent changes to this builder do not affect the returned printer.
- Returns:
- the newly created printer, null if builder cannot create a printer