Package org.joda.time.format

Class DateTimeFormatterBuilder.StringLiteral

java.lang.Object

org.joda.time.format.DateTimeFormatterBuilder.StringLiteral

All Implemented Interfaces:

InternalParser, InternalPrinter

Enclosing class:

DateTimeFormatterBuilder

static class DateTimeFormatterBuilder.StringLiteral
extends Object
implements InternalPrinter, InternalParser

Field Summary

Fields

Modifier and Type	Field	Description
private final String	iValue

Constructor Summary

Constructors

Constructor	Description
StringLiteral(String value)

Method Summary

Modifier and Type	Method	Description
int	estimateParsedLength()	Returns the expected maximum number of characters consumed.
int	estimatePrintedLength()	Returns the expected maximum number of characters produced.
int	parseInto(DateTimeParserBucket bucket, CharSequence text, int position)	Parse an element from the given text, saving any fields into the given DateTimeParserBucket.
void	printTo(Appendable appendable, 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(Appendable appendable, ReadablePartial partial, Locale locale)	Prints a ReadablePartial.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

iValue

private final String iValue

Constructor Details

StringLiteral

StringLiteral(String value)

Method Details

estimatePrintedLength

public int estimatePrintedLength()

Description copied from interface: InternalPrinter

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

Specified by:

estimatePrintedLength in interface InternalPrinter

Returns:

the estimated length

printTo

public void printTo(Appendable appendable,
 long instant,
 Chronology chrono,
 int displayOffset,
 DateTimeZone displayZone,
 Locale locale)
             throws IOException

Description copied from interface: InternalPrinter

Prints an instant from milliseconds since 1970-01-01T00:00:00Z, using the given Chronology.

Specified by:

printTo in interface InternalPrinter

Parameters:

appendable - formatted instant is appended to, 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

Throws:

IOException - if an IO error occurs

printTo

public void printTo(Appendable appendable,
 ReadablePartial partial,
 Locale locale)
             throws IOException

Description copied from interface: InternalPrinter

Prints a ReadablePartial.

Specified by:

printTo in interface InternalPrinter

Parameters:

appendable - formatted instant is appended to, not null

partial - partial to format, not null

locale - the locale to use, null means default locale

Throws:

IOException - if an IO error occurs

estimateParsedLength

public int estimateParsedLength()

Description copied from interface: InternalParser

Returns the expected maximum number of characters consumed. The actual amount should rarely exceed this estimate.

Specified by:

estimateParsedLength in interface InternalParser

Returns:

the estimated length

parseInto

public int parseInto(DateTimeParserBucket bucket,
 CharSequence text,
 int position)

Description copied from interface: InternalParser

Parse an element from the given text, saving any fields into the given DateTimeParserBucket. If the parse succeeds, the return value is the new text position. Note that the parse may succeed without fully reading the text.

If it fails, the return value is negative. To determine the position where the parse failed, apply the one's complement operator (~) on the return value.

Specified by:

parseInto in interface InternalParser

Parameters:

bucket - field are saved into this, not null

text - the text to parse, not null

position - position to start parsing from

Returns:

new position, negative value means parse failed - apply complement operator (~) to get position of failure