biweekly.io.json

Class JCalReader

java.lang.Object

biweekly.io.StreamReader

biweekly.io.json.JCalReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class JCalReader
extends StreamReader

Parses ICalendar objects from a jCal data stream (JSON).

Example:

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

Getting timezone information:

 JCalReader 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:

RFC 7265

Field Summary

Fields inherited from class biweekly.io.StreamReader

context, index, tzinfo, warnings

Constructor Summary

Constructors

Constructor and Description
JCalReader(File file)
JCalReader(InputStream in)
JCalReader(Reader reader)
JCalReader(String json)

Method Summary

Methods

Modifier and Type	Method and Description
ICalendar	_readNext() Reads the next iCalendar object from the JSON data stream.
void	close()

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

JCalReader

public JCalReader(String json)

Parameters:

json - the JSON string to read from

JCalReader

public JCalReader(InputStream in)

Parameters:

in - the input stream to read from

JCalReader

public JCalReader(File file)
           throws FileNotFoundException

Parameters:

file - the file to read from

Throws:

FileNotFoundException - if the file doesn't exist

JCalReader

public JCalReader(Reader reader)

Parameters:

reader - the reader to read from

Method Detail

_readNext

public ICalendar _readNext()
                    throws IOException

Reads the next iCalendar object from the JSON data stream.

Specified by:

_readNext in class StreamReader

Returns:

the iCalendar object or null if there are no more

Throws:

JCalParseException - if the jCal syntax is incorrect (the JSON syntax may be valid, but it is not in the correct jCal format).

JsonParseException - if the JSON syntax is incorrect

IOException - if there is a problem reading from the data stream

close

public void close()
           throws IOException

Throws:

IOException