biweekly.io

Class ParseContext

java.lang.Object

biweekly.io.ParseContext

public class ParseContext
extends Object

Stores information used during the parsing of an iCalendar object.

Author:

Michael Angstadt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParseContext.TimezonedDate Represents a property whose date-time value has a timezone.

Constructor Summary

Constructors

Constructor and Description
ParseContext()

Method Summary

Modifier and Type	Method and Description
void	addDate(ICalDate icalDate, ICalProperty property, ICalParameters parameters) Adds a parsed date to this parse context so its timezone can be applied to it after the iCalendar object has been parsed (if it has one).
void	addFloatingDate(ICalProperty property, ICalDate date) Keeps track of a date-time property that does not have a timezone (floating time), so it can be added to the TimezoneInfo object after the iCalendar object is parsed.
void	addTimezonedDate(String tzid, ICalProperty property, ICalDate date) Keeps track of a date-time property value that uses a timezone so it can be parsed later.
void	addWarning(int code, Object... args) Adds a parse warning.
void	addWarning(String message) Adds a parse warning.
List<ParseContext.TimezonedDate>	getFloatingDates() Gets the date-time properties that are in floating time (lacking a timezone).
Integer	getLineNumber() Gets the line number the parser is currently on.
String	getPropertyName() Gets the name of the property that the parser is currently parsing.
ListMultimap<String,ParseContext.TimezonedDate>	getTimezonedDates() Gets the list of date-time property values that use a timezone.
ICalVersion	getVersion() Gets the version of the iCalendar object being parsed.
List<ParseWarning>	getWarnings() Gets the parse warnings.
void	setLineNumber(Integer lineNumber) Sets the line number the parser is currently on.
void	setPropertyName(String propertyName) Sets the name of the property that the parser is currently parsing.
void	setVersion(ICalVersion version) Sets the version of the iCalendar object being parsed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParseContext

public ParseContext()

Method Detail

getVersion

public ICalVersion getVersion()

Gets the version of the iCalendar object being parsed.

Returns:

the iCalendar version

setVersion

public void setVersion(ICalVersion version)

Sets the version of the iCalendar object being parsed.

Parameters:

version - the iCalendar version

getLineNumber

public Integer getLineNumber()

Gets the line number the parser is currently on.

Returns:

the line number or null if not applicable

setLineNumber

public void setLineNumber(Integer lineNumber)

Sets the line number the parser is currently on.

Parameters:

lineNumber - the line number or null if not applicable

getPropertyName

public String getPropertyName()

Gets the name of the property that the parser is currently parsing.

Returns:

the property name (e.g. "DTSTART") or null if not applicable

setPropertyName

public void setPropertyName(String propertyName)

Sets the name of the property that the parser is currently parsing.

Parameters:

propertyName - the property name (e.g. "DTSTART") or null if not applicable

addDate

public void addDate(ICalDate icalDate,
                    ICalProperty property,
                    ICalParameters parameters)

Adds a parsed date to this parse context so its timezone can be applied to it after the iCalendar object has been parsed (if it has one).

Parameters:

icalDate - the parsed date

property - the property that the date value belongs to

parameters - the property's parameters

addTimezonedDate

public void addTimezonedDate(String tzid,
                             ICalProperty property,
                             ICalDate date)

Keeps track of a date-time property value that uses a timezone so it can be parsed later. Timezones cannot be handled until the entire iCalendar object has been parsed.

Parameters:

tzid - the timezone ID (TZID parameter)

property - the property

date - the date object that was assigned to the property object

getTimezonedDates

public ListMultimap<String,ParseContext.TimezonedDate> getTimezonedDates()

Gets the list of date-time property values that use a timezone.

Returns:

the date-time property values that use a timezone (key = TZID; value = the property)

addFloatingDate

public void addFloatingDate(ICalProperty property,
                            ICalDate date)

Keeps track of a date-time property that does not have a timezone (floating time), so it can be added to the TimezoneInfo object after the iCalendar object is parsed.

Parameters:

property - the property

date - the property's date value

getFloatingDates

public List<ParseContext.TimezonedDate> getFloatingDates()

Gets the date-time properties that are in floating time (lacking a timezone).

Returns:

the floating date-time properties

addWarning

public void addWarning(int code,
                       Object... args)

Adds a parse warning.

Parameters:

code - the warning code

args - the warning message arguments

addWarning

public void addWarning(String message)

Adds a parse warning.

Parameters:

message - the warning message

getWarnings

public List<ParseWarning> getWarnings()

Gets the parse warnings.

Returns:

the parse warnings