ezvcard.io.json

Class JCardWriter

java.lang.Object

ezvcard.io.StreamWriter

ezvcard.io.json.JCardWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class JCardWriter
extends StreamWriter
implements Flushable

Writes VCard objects to a JSON data stream (jCard format).

Example:

 VCard vcard1 = ...
 VCard vcard2 = ...
 Path file = Paths.get("vcard.json");
 try (JCardWriter writer = new JCardWriter(file)) {
   writer.write(vcard1);
   writer.write(vcard2);
 }
 

Author:

Michael Angstadt, Buddy Gorven

See Also:

RFC 7095

Field Summary

Fields inherited from class ezvcard.io.StreamWriter

addProdId, index, versionStrict

Constructor Summary

Constructors

Constructor and Description
JCardWriter(com.fasterxml.jackson.core.JsonGenerator generator)
JCardWriter(OutputStream out)
JCardWriter(OutputStream out, boolean wrapInArray)
JCardWriter(Path file)
JCardWriter(Path file, boolean wrapInArray)
JCardWriter(Writer writer)
JCardWriter(Writer writer, boolean wrapInArray)

Method Summary

Modifier and Type	Method and Description
protected void	_write(VCard vcard, List<VCardProperty> properties) Writes a vCard to the stream.
void	close() Ends the jCard data stream and closes the underlying writer.
void	closeJsonStream() Ends the jCard data stream, but does not close the underlying writer.
void	flush() Flushes the jCard data stream.
protected VCardVersion	getTargetVersion() Gets the version that the next vCard 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.
void	setPrettyPrinter(com.fasterxml.jackson.core.PrettyPrinter prettyPrinter) Sets the pretty printer to pretty-print the JSON with.

Methods inherited from class ezvcard.io.StreamWriter

getScribeIndex, isAddProdId, isVersionStrict, registerScribe, setAddProdId, setScribeIndex, setVersionStrict, write

Methods inherited from class java.lang.Object

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

Constructor Detail

JCardWriter

public JCardWriter(OutputStream out)

Parameters:

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

JCardWriter

public JCardWriter(OutputStream out,
                   boolean wrapInArray)

Parameters:

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

wrapInArray - true to enclose all written vCards in a JSON array, false not to

JCardWriter

public JCardWriter(Path file)
            throws IOException

Parameters:

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

Throws:

IOException - if there's a problem opening the file

JCardWriter

public JCardWriter(Path file,
                   boolean wrapInArray)
            throws IOException

Parameters:

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

wrapInArray - true to enclose all written vCards in a JSON array, false not to

Throws:

IOException - if there's a problem opening the file

JCardWriter

public JCardWriter(Writer writer)

Parameters:

writer - the writer to write to

JCardWriter

public JCardWriter(Writer writer,
                   boolean wrapInArray)

Parameters:

writer - the writer to write to

wrapInArray - true to enclose all written vCards in a JSON array, false not to

JCardWriter

public JCardWriter(com.fasterxml.jackson.core.JsonGenerator generator)

Parameters:

generator - the generator to write to

Method Detail

_write

protected void _write(VCard vcard,
                      List<VCardProperty> properties)
               throws IOException

Writes a vCard to the stream.

Specified by:

_write in class StreamWriter

Parameters:

vcard - the vCard that is being written

properties - the properties to write

Throws:

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

IllegalArgumentException - if a scribe hasn't been registered for a custom property class (see: registerScribe)

getTargetVersion

protected VCardVersion getTargetVersion()

Description copied from class: StreamWriter

Gets the version that the next vCard will be written as.

Specified by:

getTargetVersion in class StreamWriter

Returns:

the version

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(com.fasterxml.jackson.core.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 JCardPrettyPrinter, if setPrettyPrint(true) has been called.

flush

public void flush()
           throws IOException

Flushes the jCard data stream.

Specified by:

flush in interface Flushable

Throws:

IOException - if there's a problem flushing the stream

closeJsonStream

public void closeJsonStream()
                     throws IOException

Ends the jCard data stream, but does not close the underlying writer.

Throws:

IOException - if there's a problem closing the stream

close

public void close()
           throws IOException

Ends the jCard data stream 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