Formats and parses date specification based on RFC 2822.

This class does not support methods that influence the format. It always formats the date based on the specification below.

3.3. Date and Time Specification

Date and time occur in several header fields. This section specifies the syntax for a full date and time specification. Though folding white space is permitted throughout the date-time specification, it is RECOMMENDED that a single space be used in each place that FWS appears (whether it is required or optional); some older implementations may not interpret other occurrences of folding white space correctly.

date-time       =       [ day-of-week "," ] date FWS time [CFWS]

day-of-week     =       ([FWS] day-name) / obs-day-of-week

day-name        =       "Mon" / "Tue" / "Wed" / "Thu" /
                        "Fri" / "Sat" / "Sun"

date            =       day month year

year            =       4*DIGIT / obs-year

month           =       (FWS month-name FWS) / obs-month

month-name      =       "Jan" / "Feb" / "Mar" / "Apr" /
                        "May" / "Jun" / "Jul" / "Aug" /
                        "Sep" / "Oct" / "Nov" / "Dec"

day             =       ([FWS] 1*2DIGIT) / obs-day

time            =       time-of-day FWS zone

time-of-day     =       hour ":" minute [ ":" second ]

hour            =       2DIGIT / obs-hour

minute          =       2DIGIT / obs-minute

second          =       2DIGIT / obs-second

zone            =       (( "+" / "-" ) 4DIGIT) / obs-zone

The day is the numeric day of the month. The year is any numeric year 1900 or later.

The time-of-day specifies the number of hours, minutes, and optionally seconds since midnight of the date indicated.

The date and time-of-day SHOULD express local time.

The zone specifies the offset from Coordinated Universal Time (UTC, formerly referred to as "Greenwich Mean Time") that the date and time-of-day represent. The "+" or "-" indicates whether the time-of-day is ahead of (i.e., east of) or behind (i.e., west of) Universal Time. The first two digits indicate the number of hours difference from Universal Time, and the last two digits indicate the number of minutes difference from Universal Time. (Hence, +hhmm means +(hh * 60 + mm) minutes, and -hhmm means -(hh * 60 + mm) minutes). The form "+0000" SHOULD be used to indicate a time zone at Universal Time. Though "-0000" also indicates Universal Time, it is used to indicate that the time was generated on a system that may be in a local time zone other than Universal Time and therefore indicates that the date-time contains no information about the local time zone.

A date-time specification MUST be semantically valid. That is, the day-of-the-week (if included) MUST be the day implied by the date, the numeric day-of-month MUST be between 1 and the number of days allowed for the specified month (in the specified year), the time-of-day MUST be in the range 00:00:00 through 23:59:60 (the number of seconds allowing for a leap second; see [STD12]), and the zone MUST be within the range -9959 through +9959.

Synchronization

Date formats are not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private abstract static class	MailDateFormat.AbstractDateParser This class provides the building blocks for date parsing.
private class	MailDateFormat.Rfc2822LenientParser
private class	MailDateFormat.Rfc2822StrictParser

Field Summary

Modifier and Type	Field and Description
private static final int	LEAP_SECOND
private static final MailLogger	LOGGER
private static final String	PATTERN
private static final long	serialVersionUID Hides java.text.SimpleDateFormat.serialVersionUID.
private static final int	UNKNOWN_DAY_NAME
private static final TimeZone	UTC

Constructor Summary

Access	Constructor and Description
public	MailDateFormat() Create a new date format for the RFC2822 specification with lenient parsing.

Method Summary

Modifier and Type	Method and Description
public void	applyLocalizedPattern(String a String to be mapped to the new date and time format pattern for this format pattern) Overrides java.text.SimpleDateFormat.applyLocalizedPattern. This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific pattern.
public void	applyPattern(String the new date and time pattern for this date format pattern) Overrides java.text.SimpleDateFormat.applyPattern. This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific pattern.
public MailDateFormat	Returns: a clone of this instance clone() Overrides java.text.SimpleDateFormat.clone. Overrides Cloneable.
public StringBuffer	Returns: StringBuffer the formatted String format(Date the Date object date, StringBuffer the formatted string dateStrBuf, FieldPosition the current field position fieldPosition) Overrides java.text.SimpleDateFormat.format. Formats the given date in the format specified by RFC 2822 in the current TimeZone.
public Date	Returns: the start of the 100-year period into which two digit years are parsed get2DigitYearStart() Overrides java.text.SimpleDateFormat.get2DigitYearStart. This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates another strategy for interpreting 2-digits years.
public Date	Returns: Date the parsed date. In case of error, returns null. parse(String the formatted date to be parsed text, ParsePosition the current parse position pos) Overrides java.text.SimpleDateFormat.parse. Parses the given date in the format specified by RFC 2822.
private void	readObject(ObjectInputStream the stream containing the serialized object in) Hides java.text.SimpleDateFormat.readObject. Allows to deserialize instances that were serialized with the previous implementation.
public void	set2DigitYearStart(Date During parsing, two digit years will be placed in the range `startDate` to `startDate + 100 years`. startDate) Overrides java.text.SimpleDateFormat.set2DigitYearStart. This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates another strategy for interpreting 2-digits years.
public void	setCalendar(Calendar the new `Calendar` to be used by the date format newCalendar) Overrides java.text.DateFormat.setCalendar. This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific calendar.
public void	setDateFormatSymbols(DateFormatSymbols the new date and time format symbols newFormatSymbols) Overrides java.text.SimpleDateFormat.setDateFormatSymbols. This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates specific date format symbols.
public void	setNumberFormat(NumberFormat the given new NumberFormat. newNumberFormat) Overrides java.text.DateFormat.setNumberFormat. This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific number format.
private void	superApplyPattern(String pattern) This method allows serialization to change the pattern.
private Date	Returns: the date, as specified by the parameters toDate(int dayName, int day, int month, int year, int hour, int minute, int second, int zone) Returns the date, as specified by the parameters.
private Object	Returns: the object to be serialized writeReplace() Allows to serialize instances such that they are deserializable with the previous implementation.

Inherited from java.text.SimpleDateFormat:: equals formatToCharacterIterator getDateFormatSymbols hashCode toLocalizedPattern toPattern

Field Detail

LEAP_SECOND	back to summary
private static final int LEAP_SECOND

LOGGER	back to summary
private static final MailLogger LOGGER

PATTERN	back to summary
private static final String PATTERN

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.text.SimpleDateFormat.serialVersionUID.

UNKNOWN_DAY_NAME	back to summary
private static final int UNKNOWN_DAY_NAME

UTC	back to summary
private static final TimeZone UTC

Constructor Detail

MailDateFormat	back to summary
public MailDateFormat() Create a new date format for the RFC2822 specification with lenient parsing.

Method Detail

applyLocalizedPattern	back to summary
public void applyLocalizedPattern(String pattern) Overrides java.text.SimpleDateFormat.applyLocalizedPattern. This method always throws an UnsupportedOperationException and should not be used because RFC 2822 mandates a specific pattern. Parameters pattern:String Doc from java.text.SimpleDateFormat.applyLocalizedPattern. a String to be mapped to the new date and time format pattern for this format Annotations @Override Exceptions UnsupportedOperationException: if this method is invoked Since JavaMail 1.6

applyLocalizedPattern

Modifier and Type	Field and Description
pack-priv static final int	INVALID_CHAR
pack-priv static final int	MAX_YEAR_DIGITS
pack-priv final ParsePosition	pos
pack-priv final String	text

Modifier and Type	Method and Description
pack-priv final int	getAsciiDigit()
pack-priv final int	getChar()
pack-priv boolean	isValidZoneOffset(int offset)
pack-priv final Date	parse()
pack-priv final int	parseAsciiDigits(int count)
pack-priv final int	parseAsciiDigits(int min, int max)
pack-priv final int	parseAsciiDigits(int min, int max, boolean isEOF)
pack-priv final void	parseChar(char ch)
pack-priv final int	Returns: the java.util.Calendar constant for the parsed day name parseDayName()
pack-priv final void	parseFoldingWhiteSpace()
pack-priv final int	Returns: the java.util.Calendar constant for the parsed month name parseMonthName(boolean caseSensitive)
pack-priv final int	Returns: the number of minutes to be added to the time in the local time zone, in order to obtain the equivalent time in the UTC time zone. Returns 0 if the date-time contains no information about the local time zone. parseZoneOffset()
pack-priv final boolean	peekAsciiDigit()
pack-priv final boolean	peekChar(char ch)
pack-priv boolean	peekFoldingWhiteSpace()
pack-priv final boolean	skipAlternative(char standard, char alternative)
pack-priv final boolean	skipAlternativePair(char firstStandard, char firstAlternative, char secondStandard, char secondAlternative)
pack-priv final boolean	skipAlternativeTriple(char firstStandard, char firstAlternative, char secondStandard, char secondAlternative, char thirdStandard, char thirdAlternative)
pack-priv final boolean	skipChar(char ch)
pack-priv boolean	skipFoldingWhiteSpace()
pack-priv final boolean	skipNewline()
pack-priv final boolean	skipPair(char first, char second)
pack-priv final boolean	skipWhiteSpace()
pack-priv abstract Date	tryParse()

Modifier and Type	Method and Description
pack-priv boolean	isMonthNameCaseSensitive() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.isMonthNameCaseSensitive.
pack-priv boolean	isValidZoneOffset(int offset) Overrides javax.mail.internet.MailDateFormat.AbstractDateParser.isValidZoneOffset.
pack-priv int	parseDay() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseDay.
pack-priv void	parseFwsBetweenTimeOfDayAndZone() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseFwsBetweenTimeOfDayAndZone.
pack-priv void	parseFwsInMonth() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseFwsInMonth.
pack-priv int	parseHour() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseHour.
pack-priv int	parseMinute() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseMinute.
pack-priv int	parseOptionalBegin() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseOptionalBegin.
pack-priv int	parseSecond() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseSecond.
pack-priv int	parseYear() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseYear.
pack-priv int	parseZone() Overrides javax.mail.internet.MailDateFormat.Rfc2822StrictParser.parseZone.
pack-priv boolean	peekFoldingWhiteSpace() Overrides javax.mail.internet.MailDateFormat.AbstractDateParser.peekFoldingWhiteSpace.
pack-priv boolean	skipFoldingWhiteSpace() Overrides javax.mail.internet.MailDateFormat.AbstractDateParser.skipFoldingWhiteSpace.

Modifier and Type	Method and Description
pack-priv boolean	isMonthNameCaseSensitive()
pack-priv int	parseDay()
pack-priv void	parseFwsBetweenTimeOfDayAndZone()
pack-priv void	parseFwsInMonth()
pack-priv int	parseHour()
pack-priv int	parseMinute()
pack-priv int	Returns: the java.util.Calendar constant for the parsed month name parseMonth()
pack-priv int	Returns: the java.util.Calendar constant for the parsed day name, or UNKNOWN_DAY_NAME iff the begin is missing parseOptionalBegin()
pack-priv int	parseSecond()
pack-priv int	parseYear()
pack-priv int	parseZone()
pack-priv Date	tryParse() Implements abstract javax.mail.internet.MailDateFormat.AbstractDateParser.tryParse.

public Class MailDateFormat

Synchronization

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class MailDateFormat.AbstractDateParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MailDateFormat.Rfc2822LenientParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MailDateFormat.Rfc2822StrictParser

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail