ezvcard
Class Ezvcard.WriterChainText

java.lang.Object
  ezvcard.Ezvcard.WriterChainText

Enclosing class:

Ezvcard

public static class Ezvcard.WriterChainText
extends Object

Chainer class for writing plain text vCards

See Also:

Ezvcard.write(Collection), Ezvcard.write(VCard...)

Method Summary

Ezvcard.WriterChainText	caretEncoding(boolean enable) Sets whether the writer will use circumflex accent encoding for vCard 3.0 and 4.0 parameter values (disabled by default).
String	go() Writes the vCards to a string.
void	go(File file) Writes the vCards to a file.
void	go(File file, boolean append) Writes the vCards to a file.
void	go(OutputStream out) Writes the vCards to an output stream.
void	go(Writer writer) Writes the vCards to a writer.
Ezvcard.WriterChainText	prodId(boolean include) Sets whether or not to add a PRODID property to each vCard, saying that the vCard was generated by this library.
Ezvcard.WriterChainText	register(VCardPropertyScribe<? extends VCardProperty> scribe) Registers a property scribe.
Ezvcard.WriterChainText	version(VCardVersion version) Sets the version that all the vCards will be marshalled to.
Ezvcard.WriterChainText	versionStrict(boolean versionStrict) Sets whether properties that do not support the target version will be excluded from the written vCard.

Methods inherited from class java.lang.Object

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

Method Detail

version

public Ezvcard.WriterChainText version(VCardVersion version)

Sets the version that all the vCards will be marshalled to. The version that is attached to each individual VCard object will be ignored.

If no version is passed into this method, the writer will look at the version attached to each individual VCard object and marshal it to that version. And if a VCard object has no version attached to it, then it will be marshalled to version 3.0.

Parameters:

version - the version to marshal the vCards to

Returns:

this

prodId

public Ezvcard.WriterChainText prodId(boolean include)

Sets whether or not to add a PRODID property to each vCard, saying that the vCard was generated by this library. For 2.1 vCards, the extended property X-PRODID is used, since PRODID is not supported by that version.

Parameters:

include - true to add PRODID (default), false not to

Returns:

this

caretEncoding

public Ezvcard.WriterChainText caretEncoding(boolean enable)

Sets whether the writer will use circumflex accent encoding for vCard 3.0 and 4.0 parameter values (disabled by default).

Parameters:

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

Returns:

this

See Also:

VCardWriter.setCaretEncodingEnabled(boolean), RFC 6868

versionStrict

public Ezvcard.WriterChainText versionStrict(boolean versionStrict)

Sets whether properties that do not support the target version will be excluded from the written vCard.

Parameters:

versionStrict - true to exclude properties that do not support the target version, false to include them anyway (defaults to true)

Returns:

this

register

public Ezvcard.WriterChainText register(VCardPropertyScribe<? extends VCardProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe to register

Returns:

this

go

public String go()

Writes the vCards to a string.

Returns:

the vCard string

go

public void go(OutputStream out)
        throws IOException

Writes the vCards to an output stream.

Parameters:

out - the output stream to write to

Throws:

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

go

public void go(File file)
        throws IOException

Writes the vCards to a file. If the file exists, it will be overwritten.

Parameters:

file - the file to write to

Throws:

IOException - if there's a problem writing to the file

go

public void go(File file,
               boolean append)
        throws IOException

Writes the vCards to a file.

Parameters:

file - the file to write to

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

Throws:

IOException - if there's a problem writing to the file

go

public void go(Writer writer)
        throws IOException

Writes the vCards to a writer.

Parameters:

writer - the writer to write to

Throws:

IOException - if there's a problem writing to the writer