oracle.ifs.protocols.utils

Class VerifyDateFormat

java.lang.Object

java.text.Format

java.text.DateFormat

java.text.SimpleDateFormat

oracle.ifs.protocols.utils.VerifyDateFormat

All Implemented Interfaces:

Serializable, Cloneable

public class VerifyDateFormat
extends SimpleDateFormat

Replacement for java.text.SimpleDateFormat. This version verifies the correctness of the time pattern string at construction time.

Note: This class is designed to adhere strictly to the description of the date format string in the JDK docs for java.text.SimpleDateFormat. This means that I throw an Exception on the string "'hi there", even though SimpleDateFormat is lenient and interprets it as "'hi there'".

There exist some minor bugs in the 1.1.8 implementation of java.text.SimpleDateFormat. As an example, the format string "'''hi'" results in dates looking like "''hi" when they should look like "'hi". These bugs have been fixed by JDK 1.2.2_06. So far as I know, my verifier parses strings correctly and strictly, which means that some strings that worked with the 1.1.8 SimpleDateFormat might not work with VerifyDateFormat. This is fine though, since we don't want to allow Strings that don't work with 1.2.2

Version:

1.0

Author:

David Menestrina

See Also:

Serialized Form

(Unpublished)

Nested Class Summary

Nested classes/interfaces inherited from class java.text.DateFormat

DateFormat.Field

Field Summary

Fields inherited from class java.text.DateFormat

AM_PM_FIELD, calendar, DATE_FIELD, DAY_OF_WEEK_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD, DAY_OF_YEAR_FIELD, DEFAULT, ERA_FIELD, FULL, HOUR_OF_DAY0_FIELD, HOUR_OF_DAY1_FIELD, HOUR0_FIELD, HOUR1_FIELD, LONG, MEDIUM, MILLISECOND_FIELD, MINUTE_FIELD, MONTH_FIELD, numberFormat, SECOND_FIELD, SHORT, TIMEZONE_FIELD, WEEK_OF_MONTH_FIELD, WEEK_OF_YEAR_FIELD, YEAR_FIELD

Constructor Summary

Constructors

Constructor and Description
VerifyDateFormat(String format) Constructor that mirrors SimpleDateFormat(String)
VerifyDateFormat(String format, DateFormatSymbols dfs) Constructor that mirrors SimpleDateFormat(String, DateFormatSymbols)
VerifyDateFormat(String format, Locale loc) Constructor that mirrors SimpleDateFormat(String, Locale)

Method Summary

Modifier and Type	Method and Description
protected static int	eatLiteralString(String str, int i) Advances to the end of the current literal string.
protected static boolean	isCharValid(char ch) Checks whether the given character is valid (according to the javadoc for SimpleDateFormat)
static boolean	isFormatStringValid(String str) Checks whether the given date format string is valid (according to the javadoc for SimpleDateFormat)

Methods inherited from class java.text.SimpleDateFormat

applyLocalizedPattern, applyPattern, clone, equals, format, formatToCharacterIterator, get2DigitYearStart, getDateFormatSymbols, hashCode, parse, set2DigitYearStart, setDateFormatSymbols, toLocalizedPattern, toPattern

Methods inherited from class java.text.DateFormat

format, format, getAvailableLocales, getCalendar, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getNumberFormat, getTimeInstance, getTimeInstance, getTimeInstance, getTimeZone, isLenient, parse, parseObject, setCalendar, setLenient, setNumberFormat, setTimeZone

Methods inherited from class java.text.Format

format, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VerifyDateFormat

public VerifyDateFormat(String format)

Constructor that mirrors SimpleDateFormat(String)

Throws:

IllegalArgumentException - if the format is invalid

(Unpublished)

VerifyDateFormat

public VerifyDateFormat(String format,
                        DateFormatSymbols dfs)

Constructor that mirrors SimpleDateFormat(String, DateFormatSymbols)

Throws:

IllegalArgumentException - if the format is invalid

(Unpublished)

VerifyDateFormat

public VerifyDateFormat(String format,
                        Locale loc)

Constructor that mirrors SimpleDateFormat(String, Locale)

Throws:

IllegalArgumentException - if the format is invalid

(Unpublished)

Method Detail

isFormatStringValid

public static boolean isFormatStringValid(String str)

Checks whether the given date format string is valid (according to the javadoc for SimpleDateFormat)

Parameters:

str - the string to test for validity

(Unpublished)

eatLiteralString

protected static int eatLiteralString(String str,
                                      int i)

Advances to the end of the current literal string.

Date format strings can have literal strings enclosed in ' characters. Everything within the ' characters is to be treated literally, except for ' characters themselves. If two ' in a row occur, they are treated as one ', and the literal string continues.

This function takes in a string to parse, and an index indicating the location of the opening '. It returns an index indicating the location of the ending '.

If the literal string doesn't end, or on other errors, this returns -1.

Parameters:

str - the string

i - the index into the string

(Unpublished)

isCharValid

protected static boolean isCharValid(char ch)

Checks whether the given character is valid (according to the javadoc for SimpleDateFormat)

Parameters:

ch - the character to test for validity

(Unpublished)