Package com.aquima.interactions.foundation.text.symbol

Class AbstractFormatOnlySymbol

java.lang.Object

com.aquima.interactions.foundation.text.symbol.AbstractFormatOnlySymbol

All Implemented Interfaces:

IDateSymbol, Serializable

Direct Known Subclasses:

LeadingZeroShortHourSymbol, MeridiemMarkerSymbol, ShortDateSymbol, ShortHourSymbol, ShortMonthSymbol, ShortYearSymbol, SpelledDayOfWeekSymbol, SpelledDaySymbol, SpelledMonthSymbol, SpelledYearSymbol

public abstract class AbstractFormatOnlySymbol
extends Object
implements IDateSymbol

Extend the AbstractFormatOnlySymbol when the symbol is for formatting dates only. When used for parsing of strings this symbol throws an exception.

Since:

6.0

Author:

Jon van Leuven

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractFormatOnlySymbol()

Method Summary

Modifier and Type	Method	Description
int	getWidth()	Returns the width of the symbol.
int	parse(String dateString, int pos, int maxWidth)	Parses part of the dateString parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.foundation.text.IDateSymbol

format, getPattern

Constructor Details

AbstractFormatOnlySymbol

public AbstractFormatOnlySymbol()

Method Details

getWidth

public int getWidth()

Description copied from interface: IDateSymbol

Returns the width of the symbol. When parsing a date string without separators, this width is used to calculate the expected total string length. When parsing a date string with separators, this width is used to limit the maximum amount of characters to consider. The result of this method is used during formatting to determine the number of leading zeroes required.

Specified by:

getWidth in interface IDateSymbol

Returns:

int The width of this symbol.

parse

public int parse(String dateString,
 int pos,
 int maxWidth)

Description copied from interface: IDateSymbol

Parses part of the dateString parameter. This method may return a negative integer to indicate failure.

Specified by:

parse in interface IDateSymbol

Parameters:

dateString - String value containing the date/time representation to be parsed.

pos - Integer value indicating the position at which to start parsing.

maxWidth - Integer value indicating the maximum number of characters to consume.

Returns:

• Non-negative integer containing the value parsed.
• Negative integer indicating a parse error. (Will be handled by DateFormat by throwing a ParseException indicating the position of the error).