biweekly.io.text

Class ICalReader

java.lang.Object

biweekly.io.StreamReader

biweekly.io.text.ICalReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class ICalReader
extends StreamReader

Parses ICalendar objects from a plain-text iCalendar data stream.

Example:

 File file = new File("icals.ics");
 ICalReader reader = null;
 try {
   reader = new ICalReader(file);
   ICalendar ical;
   while ((ical = reader.readNext()) != null){
     ...
   }
 } finally {
   if (reader != null) reader.close();
 }
 

Getting timezone information:

 ICalReader reader = ...
 ICalendar ical = reader.readNext();
 TimezoneInfo tzinfo = reader.getTimezoneInfo();
 
 //get the VTIMEZONE components that were parsed
 //the VTIMEZONE components will NOT be in the ICalendar object
 Collection<VTimezone> vtimezones = tzinfo.getComponents();
 
 //get the timezone that a property was originally formatted in
 DateStart dtstart = ical.getEvents().get(0).getDateStart();
 TimeZone tz = tzinfo.getTimeZone(dtstart);
 

Author:

Michael Angstadt

See Also:

1.0 specs, RFC 2445, RFC 5545

Field Summary

Fields inherited from class biweekly.io.StreamReader

context, index, tzinfo, warnings

Constructor Summary

Constructors

Constructor and Description
ICalReader(File file)
ICalReader(InputStream in)
ICalReader(Reader reader)
ICalReader(String str)

Method Summary

Methods

Modifier and Type	Method and Description
protected ICalendar	_readNext() Reads the next iCalendar object from the data stream.
void	close() Closes the underlying Reader object.
Charset	getDefaultQuotedPrintableCharset() Gets the character set to use when decoding quoted-printable values if the property has no CHARSET parameter, or if the CHARSET parameter is not a valid character set.
boolean	isCaretDecodingEnabled() Gets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).
void	setCaretDecodingEnabled(boolean enable) Sets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).
void	setDefaultQuotedPrintableCharset(Charset charset) Sets the character set to use when decoding quoted-printable values if the property has no CHARSET parameter, or if the CHARSET parameter is not a valid character set.

Methods inherited from class biweekly.io.StreamReader

getScribeIndex, getTimezoneInfo, getWarnings, readAll, readNext, registerScribe, registerScribe, setScribeIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

ICalReader

public ICalReader(String str)

Parameters:

str - the string to read from

ICalReader

public ICalReader(InputStream in)

Parameters:

in - the input stream to read from

ICalReader

public ICalReader(File file)
           throws FileNotFoundException

Parameters:

file - the file to read from

Throws:

FileNotFoundException - if the file doesn't exist

ICalReader

public ICalReader(Reader reader)

Parameters:

reader - the reader to read from

Method Detail

isCaretDecodingEnabled

public boolean isCaretDecodingEnabled()

Gets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default). This escaping mechanism allows newlines and double quotes to be included in parameter values.

Returns:

true if circumflex accent decoding is enabled, false if not

See Also:

ICalRawReader.isCaretDecodingEnabled()

setCaretDecodingEnabled

public void setCaretDecodingEnabled(boolean enable)

Sets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default). This escaping mechanism allows newlines and double quotes to be included in parameter values.

Parameters:

enable - true to use circumflex accent decoding, false not to

See Also:

ICalRawReader.setCaretDecodingEnabled(boolean)

getDefaultQuotedPrintableCharset

public Charset getDefaultQuotedPrintableCharset()

Gets the character set to use when decoding quoted-printable values if the property has no CHARSET parameter, or if the CHARSET parameter is not a valid character set.

By default, the Reader's character encoding will be used. If the Reader has no character encoding, then the system's default character encoding will be used.

Returns:

the character set

setDefaultQuotedPrintableCharset

public void setDefaultQuotedPrintableCharset(Charset charset)

Sets the character set to use when decoding quoted-printable values if the property has no CHARSET parameter, or if the CHARSET parameter is not a valid character set.

By default, the Reader's character encoding will be used. If the Reader has no character encoding, then the system's default character encoding will be used.

Parameters:

charset - the character set

_readNext

protected ICalendar _readNext()
                       throws IOException

Description copied from class: StreamReader

Reads the next iCalendar object from the data stream.

Specified by:

_readNext in class StreamReader

Returns:

the next iCalendar object or null if there are no more

Throws:

IOException - if there's a problem reading from the stream

close

public void close()
           throws IOException

Closes the underlying Reader object.

Throws:

IOException