biweekly.io.json

Class JCalWriter

java.lang.Object

biweekly.io.json.JCalWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class JCalWriter
extends Object
implements Closeable, Flushable

Writes ICalendar objects to a JSON data stream (jCal).

Example:

 List<ICalendar> icals = ... 
 OutputStream out = ...
 JCalWriter jcalWriter = new JCalWriter(out);
 for (ICalendar ical : icals){
   jcalWriter.write(ical);
 }
 jcalWriter.close();
 

Author:

Michael Angstadt

See Also:

RFC 7265

Constructor Summary

Constructors

Constructor and Description
JCalWriter(File file) Creates a jCal writer that writes to a file.
JCalWriter(File file, boolean wrapInArray) Creates a jCal writer that writes to a file.
JCalWriter(OutputStream outputStream) Creates a jCal writer that writes to an output stream.
JCalWriter(OutputStream outputStream, boolean wrapInArray) Creates a jCal writer that writes to an output stream.
JCalWriter(Writer writer) Creates a jCal writer that writes to a writer.
JCalWriter(Writer writer, boolean wrapInArray) Creates a jCal writer that writes to a writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Finishes writing the JSON document and closes the underlying Writer object.
void	closeJsonStream() Finishes writing the JSON document so that it is syntactically correct.
void	flush() Flushes the stream.
ScribeIndex	getScribeIndex() Gets the object that manages the component/property scribes.
boolean	isIndent() Gets whether or not the JSON will be pretty-printed.
void	registerScribe(ICalComponentScribe<? extends ICalComponent> scribe) Registers an experimental component scribe.
void	registerScribe(ICalPropertyScribe<? extends ICalProperty> scribe) Registers an experimental property scribe.
void	setIndent(boolean indent) Sets whether or not to pretty-print the JSON.
void	setScribeIndex(ScribeIndex index) Sets the object that manages the component/property scribes.
void	write(ICalendar ical) Writes an iCalendar object to the data stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

JCalWriter

public JCalWriter(OutputStream outputStream)

Creates a jCal writer that writes to an output stream.

Parameters:

outputStream - the output stream to write to

JCalWriter

public JCalWriter(OutputStream outputStream,
          boolean wrapInArray)

Creates a jCal writer that writes to an output stream.

Parameters:

outputStream - the output stream to write to

wrapInArray - true to wrap all iCalendar objects in a parent array, false not to (useful when writing more than one iCalendar object)

JCalWriter

public JCalWriter(File file)
           throws IOException

Creates a jCal writer that writes to a file.

Parameters:

file - the file to write to

Throws:

IOException - if the file cannot be written to

JCalWriter

public JCalWriter(File file,
          boolean wrapInArray)
           throws IOException

Creates a jCal writer that writes to a file.

Parameters:

file - the file to write to

wrapInArray - true to wrap all iCalendar objects in a parent array, false not to (useful when writing more than one iCalendar object)

Throws:

IOException - if the file cannot be written to

JCalWriter

public JCalWriter(Writer writer)

Creates a jCal writer that writes to a writer.

Parameters:

writer - the writer to the data stream

JCalWriter

public JCalWriter(Writer writer,
          boolean wrapInArray)

Creates a jCal writer that writes to a writer.

Parameters:

writer - the writer to the data stream

wrapInArray - true to wrap all iCalendar objects in a parent array, false not to (useful when writing more than one iCalendar object)

Method Detail

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

isIndent

public boolean isIndent()

Gets whether or not the JSON will be pretty-printed.

Returns:

true if it will be pretty-printed, false if not (defaults to false)

setIndent

public void setIndent(boolean indent)

Sets whether or not to pretty-print the JSON.

Parameters:

indent - true to pretty-print it, false not to (defaults to false)

write

public void write(ICalendar ical)
           throws IOException

Writes an iCalendar object to the data stream.

Parameters:

ical - the iCalendar object to write

Throws:

IllegalArgumentException - if the scribe class for a component or property object cannot be found (only happens when an experimental property/component scribe is not registered with the registerScribe method.)

IOException - if there's a problem writing to the data stream

flush

public void flush()
           throws IOException

Flushes the stream.

Specified by:

flush in interface Flushable

Throws:

IOException - if there's a problem flushing the stream

close

public void close()
           throws IOException

Finishes writing the JSON document and closes the underlying Writer object.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if there's a problem closing the stream

closeJsonStream

public void closeJsonStream()
                     throws IOException

Finishes writing the JSON document so that it is syntactically correct. No more iCalendar objects can be written once this method is called.

Throws:

IOException - if there's a problem writing to the data stream