biweekly.io.json

Class JCalWriter

java.lang.Object

biweekly.io.StreamWriter

biweekly.io.json.JCalWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class JCalWriter
extends StreamWriter
implements Flushable

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

Example:

 ICalendar ical1 = ...
 ICalendar ical2 = ...
 File file = new File("icals.json");
 JCalWriter writer = null;
 try {
   writer = new JCalWriter(file);
   writer.write(ical1);
   writer.write(ical2);
 } finally {
   if (writer != null) writer.close();
 }
 

Author:

Michael Angstadt

See Also:

RFC 7265

Field Summary

Fields inherited from class biweekly.io.StreamWriter

context, globalTimezone, index

Constructor Summary

Constructors

Constructor and Description
JCalWriter(File file)
JCalWriter(File file, boolean wrapInArray)
JCalWriter(JsonGenerator generator)
JCalWriter(OutputStream out)
JCalWriter(OutputStream out, boolean wrapInArray)
JCalWriter(Writer writer)
JCalWriter(Writer writer, boolean wrapInArray)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_write(ICalendar ical) Writes an iCalendar object to the data stream.
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.
protected ICalVersion	getTargetVersion() Gets the version that the next iCalendar object will be written as.
boolean	isPrettyPrint() Gets whether or not the JSON will be pretty-printed.
void	setPrettyPrint(boolean prettyPrint) Sets whether or not to pretty-print the JSON.

Methods inherited from class biweekly.io.StreamWriter

getGlobalTimezone, getScribeIndex, getTimezoneComponents, registerScribe, registerScribe, setGlobalTimezone, setScribeIndex, write

Methods inherited from class java.lang.Object

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

Constructor Detail

JCalWriter

public JCalWriter(OutputStream out)

Parameters:

out - the output stream to write to (UTF-8 encoding will be used)

JCalWriter

public JCalWriter(OutputStream out,
          boolean wrapInArray)

Parameters:

out - the output stream to write to (UTF-8 encoding will be used)

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

Parameters:

file - the file to write to (UTF-8 encoding will be used)

Throws:

IOException - if the file cannot be written to

JCalWriter

public JCalWriter(File file,
          boolean wrapInArray)
           throws IOException

Parameters:

file - the file to write to (UTF-8 encoding will be used)

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)

Parameters:

writer - the writer to write to

JCalWriter

public JCalWriter(Writer writer,
          boolean wrapInArray)

Parameters:

writer - the writer 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(JsonGenerator generator)

Parameters:

generator - the generator to write to

Method Detail

isPrettyPrint

public boolean isPrettyPrint()

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

Returns:

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

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Sets whether or not to pretty-print the JSON.

Parameters:

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

_write

protected void _write(ICalendar ical)
               throws IOException

Description copied from class: StreamWriter

Writes an iCalendar object to the data stream.

Specified by:

_write in class StreamWriter

Parameters:

ical - the iCalendar object to write

Throws:

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

getTargetVersion

protected ICalVersion getTargetVersion()

Description copied from class: StreamWriter

Gets the version that the next iCalendar object will be written as.

Specified by:

getTargetVersion in class StreamWriter

Returns:

the version

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