biweekly.io.json

Class JCalReader

java.lang.Object

biweekly.io.json.JCalReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class JCalReader
extends Object
implements Closeable

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

Example:

 InputStream in = ...
 JCalReader jcalReader = new JCalReader(in);
 ICalendar ical;
 while ((ical = jcalReader.readNext()) != null){
   ...
 }
 jcalReader.close();
 

Author:

Michael Angstadt

See Also:

RFC 7265

Constructor Summary

Constructors

Constructor and Description
JCalReader(File file) Creates a jCard reader.
JCalReader(InputStream in) Creates a jCard reader.
JCalReader(Reader reader) Creates a jCard reader.
JCalReader(String json) Creates a jCard reader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
ScribeIndex	getScribeIndex() Gets the object that manages the component/property scribes.
List<String>	getWarnings() Gets the warnings from the last iCalendar object that was unmarshalled.
ICalendar	readNext() Reads the next iCalendar object from the JSON data stream.
void	registerScribe(ICalComponentScribe<? extends ICalComponent> scribe) Registers an experimental component scribe.
void	registerScribe(ICalPropertyScribe<? extends ICalProperty> scribe) Registers an experimental property scribe.
void	setScribeIndex(ScribeIndex index) Sets the object that manages the component/property scribes.

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)

Creates a jCard reader.

Parameters:

json - the JSON string

JCalReader

public JCalReader(InputStream in)

Creates a jCard reader.

Parameters:

in - the input stream to read the vCards from

JCalReader

public JCalReader(File file)
           throws FileNotFoundException

Creates a jCard reader.

Parameters:

file - the file to read the vCards from

Throws:

FileNotFoundException - if the file doesn't exist

JCalReader

public JCalReader(Reader reader)

Creates a jCard reader.

Parameters:

reader - the reader to read the vCards from

Method Detail

getWarnings

public List<String> getWarnings()

Gets the warnings from the last iCalendar object that was unmarshalled. This list is reset every time a new iCalendar object is read.

Returns:

the warnings or empty list if there were no warnings

registerScribe

public void registerScribe(ICalPropertyScribe<? extends ICalProperty> scribe)

Registers an experimental property scribe. Can also be used to override the scribe of a standard property (such as DTSTART). Calling this method is the same as calling:

getScribeIndex().register(scribe).

Parameters:

scribe - the scribe to register

registerScribe

public void registerScribe(ICalComponentScribe<? extends ICalComponent> scribe)

Registers an experimental component scribe. Can also be used to override the scribe of a standard component (such as VEVENT). Calling this method is the same as calling:

getScribeIndex().register(scribe).

Parameters:

scribe - the scribe to register

getScribeIndex

public ScribeIndex getScribeIndex()

Gets the object that manages the component/property scribes.

Returns:

the scribe index

setScribeIndex

public void setScribeIndex(ScribeIndex index)

Sets the object that manages the component/property scribes.

Parameters:

index - the scribe index

readNext

public ICalendar readNext()
                   throws IOException

Reads the next iCalendar object from the JSON data stream.

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException