biweekly.io.json

Class JCalRawWriter

java.lang.Object

biweekly.io.json.JCalRawWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class JCalRawWriter
extends Object
implements Closeable, Flushable

Writes data to an iCalendar JSON data stream (jCal).

Author:

Michael Angstadt

See Also:

RFC 7265

Constructor Summary

Constructors

Constructor and Description
JCalRawWriter(JsonGenerator generator)
JCalRawWriter(Writer writer, boolean wrapInArray)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Finishes writing the JSON document and closes the underlying Writer.
void	closeJsonStream() Finishes writing the JSON document so that it is syntactically correct.
void	flush() Flushes the JSON stream.
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.
void	setPrettyPrinter(PrettyPrinter prettyPrinter) Sets the pretty printer to pretty-print the JSON with.
void	writeEndComponent() Closes the current component array.
void	writeProperty(String propertyName, ICalDataType dataType, JCalValue value) Writes a property to the current component.
void	writeProperty(String propertyName, ICalParameters parameters, ICalDataType dataType, JCalValue value) Writes a property to the current component.
void	writeStartComponent(String componentName) Writes the beginning of a new component array.

Methods inherited from class java.lang.Object

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

Constructor Detail

JCalRawWriter

public JCalRawWriter(Writer writer,
             boolean wrapInArray)

Parameters:

writer - the writer to wrap

wrapInArray - true to wrap everything in an array, false not to (useful when writing more than one iCalendar object)

JCalRawWriter

public JCalRawWriter(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)

setPrettyPrinter

public void setPrettyPrinter(PrettyPrinter prettyPrinter)

Sets the pretty printer to pretty-print the JSON with. Note that this method implicitly enables indenting, so setPrettyPrint(true) does not also need to be called.

Parameters:

prettyPrinter - the custom pretty printer (defaults to an instance of JCalPrettyPrinter, if setPrettyPrint(true) has been called)

writeStartComponent

public void writeStartComponent(String componentName)
                         throws IOException

Writes the beginning of a new component array.

Parameters:

componentName - the component name (e.g. "vevent")

Throws:

IOException - if there's an I/O problem

writeEndComponent

public void writeEndComponent()
                       throws IOException

Closes the current component array.

Throws:

IllegalStateException - if there are no open components ( writeStartComponent(String) must be called first)

IOException - if there's an I/O problem

writeProperty

public void writeProperty(String propertyName,
                 ICalDataType dataType,
                 JCalValue value)
                   throws IOException

Writes a property to the current component.

Parameters:

propertyName - the property name (e.g. "version")

dataType - the property's data type (e.g. "text")

value - the property value

Throws:

IllegalStateException - if there are no open components ( writeStartComponent(String) must be called first) or if the last method called was writeEndComponent().

IOException - if there's an I/O problem

writeProperty

public void writeProperty(String propertyName,
                 ICalParameters parameters,
                 ICalDataType dataType,
                 JCalValue value)
                   throws IOException

Writes a property to the current component.

Parameters:

propertyName - the property name (e.g. "version")

parameters - the parameters

dataType - the property's data type (e.g. "text")

value - the property value

Throws:

IllegalStateException - if there are no open components ( writeStartComponent(String) must be called first) or if the last method called was writeEndComponent().

IOException - if there's an I/O problem

flush

public void flush()
           throws IOException

Flushes the JSON stream.

Specified by:

flush in interface Flushable

Throws:

IOException - if there's a problem flushing the stream

closeJsonStream

public void closeJsonStream()
                     throws IOException

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

Throws:

IOException - if there's a problem closing the stream

close

public void close()
           throws IOException

Finishes writing the JSON document and closes the underlying Writer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if there's a problem closing the stream