org.opencrx.application.uses.ezvcard.io.text

Class VCardWriter

java.lang.Object

org.opencrx.application.uses.ezvcard.io.StreamWriter

org.opencrx.application.uses.ezvcard.io.text.VCardWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class VCardWriter
extends StreamWriter
implements java.io.Flushable

Writes VCard objects to a plain-text vCard data stream.

Example:

 VCard vcard1 = ...
 VCard vcard2 = ...
 
 File file = new File("vcard.vcf");
 VCardWriter vcardWriter = new VCardWriter(file, VCardVersion.V3_0);
 vcardWriter.write(vcard1);
 vcardWriter.write(vcard2);
 vcardWriter.close();
 

Changing the line folding settings:

 VCardWriter writer = new VCardWriter(...);
 
 //disable line folding
 writer.getRawWriter().getFoldedLineWriter().setLineLength(null);
 
 //change line length
 writer.getRawWriter().getFoldedLineWriter().setLineLength(50);
 
 //change folded line indent string
 writer.getRawWriter().getFoldedLineWriter().setIndent("\t");
 
 //change newline character
 writer.getRawWriter().getFoldedLineWriter().setNewline("**");
 

Author:

Michael Angstadt

Field Summary

Fields inherited from class org.opencrx.application.uses.ezvcard.io.StreamWriter

addProdId, index, versionStrict

Constructor Summary

Constructors

Constructor and Description
VCardWriter(java.io.File file, boolean append, VCardVersion targetVersion) Creates a vCard writer.
VCardWriter(java.io.File file, VCardVersion targetVersion) Creates a vCard writer.
VCardWriter(java.io.OutputStream out, VCardVersion targetVersion) Creates a vCard writer.
VCardWriter(java.io.Writer writer, VCardVersion targetVersion) Creates a vCard writer.

Method Summary

Modifier and Type	Method and Description
protected void	_write(VCard vcard, java.util.List<VCardProperty> propertiesToAdd) Writes a vCard to the stream.
void	close() Closes the underlying Writer object.
void	flush() Flushes the underlying Writer object.
VCardRawWriter	getRawWriter() Gets the writer that this object wraps.
VCardVersion	getTargetVersion() Gets the version that the vCards should adhere to.
boolean	isCaretEncodingEnabled() Gets whether the writer will apply circumflex accent encoding on parameter values (disabled by default, only applies to 3.0 and 4.0 vCards).
void	setCaretEncodingEnabled(boolean enable) Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default, only applies to 3.0 and 4.0 vCards).
void	setTargetVersion(VCardVersion targetVersion) Sets the version that the vCards should adhere to.

Methods inherited from class org.opencrx.application.uses.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

VCardWriter

public VCardWriter(java.io.OutputStream out,
                   VCardVersion targetVersion)

Creates a vCard writer.

Parameters:

out - the output stream to write the vCard to

targetVersion - the version that the vCards should conform to (if set to "4.0", vCards will be written in UTF-8 encoding)

VCardWriter

public VCardWriter(java.io.File file,
                   VCardVersion targetVersion)
            throws java.io.IOException

Creates a vCard writer.

Parameters:

file - the file to write the vCard to

targetVersion - the version that the vCards should conform to (if set to "4.0", vCards will be written in UTF-8 encoding)

Throws:

java.io.IOException - if there's a problem opening the file

VCardWriter

public VCardWriter(java.io.File file,
                   boolean append,
                   VCardVersion targetVersion)
            throws java.io.IOException

Creates a vCard writer.

Parameters:

file - the file to write the vCard to

append - true to append to the end of the file, false to overwrite it

targetVersion - the version that the vCards should conform to (if set to "4.0", vCards will be written in UTF-8 encoding)

Throws:

java.io.IOException - if there's a problem opening the file

VCardWriter

public VCardWriter(java.io.Writer writer,
                   VCardVersion targetVersion)

Creates a vCard writer.

Parameters:

writer - the writer to write the vCard to

targetVersion - the version that the vCards should conform to

Method Detail

getRawWriter

public VCardRawWriter getRawWriter()

Gets the writer that this object wraps.

Returns:

the raw writer

getTargetVersion

public VCardVersion getTargetVersion()

Gets the version that the vCards should adhere to.

Specified by:

getTargetVersion in class StreamWriter

Returns:

the vCard version

setTargetVersion

public void setTargetVersion(VCardVersion targetVersion)

Sets the version that the vCards should adhere to.

Parameters:

targetVersion - the vCard version

isCaretEncodingEnabled

public boolean isCaretEncodingEnabled()

Gets whether the writer will apply circumflex accent encoding on parameter values (disabled by default, only applies to 3.0 and 4.0 vCards). This escaping mechanism allows for newlines and double quotes to be included in parameter values.

When disabled, the writer will replace newlines with spaces and double quotes with single quotes.

Returns:

true if circumflex accent encoding is enabled, false if not

See Also:

VCardRawWriter.isCaretEncodingEnabled()

setCaretEncodingEnabled

public void setCaretEncodingEnabled(boolean enable)

Sets whether the writer will apply circumflex accent encoding on parameter values (disabled by default, only applies to 3.0 and 4.0 vCards). This escaping mechanism allows for newlines and double quotes to be included in parameter values.

When disabled, the writer will replace newlines with spaces and double quotes with single quotes.

Parameters:

enable - true to use circumflex accent encoding, false not to

See Also:

VCardRawWriter.setCaretEncodingEnabled(boolean)

_write

protected void _write(VCard vcard,
                      java.util.List<VCardProperty> propertiesToAdd)
               throws java.io.IOException

Description copied from class: StreamWriter

Writes a vCard to the stream.

Specified by:

_write in class StreamWriter

Parameters:

vcard - the vCard that is being written

propertiesToAdd - the properties to write

Throws:

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

flush

public void flush()
           throws java.io.IOException

Flushes the underlying Writer object.

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException - if there's a problem flushing the writer

close

public void close()
           throws java.io.IOException

Closes the underlying Writer object.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if there's a problem closing the writer