ezvcard.io.text

Class VCardReader

java.lang.Object

ezvcard.io.StreamReader

ezvcard.io.text.VCardReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class VCardReader
extends StreamReader

Parses VCard objects from a plain-text vCard data stream.

Example:

 Path file = Paths.get("vcards.vcf");
 try (VCardReader reader = new VCardReader(file)) {
   VCard vcard;
   while ((vcard = reader.readNext()) != null) {
     //...
   }
 }
 

Author:

Michael Angstadt

See Also:

vCard 2.1, RFC 2426 (3.0), RFC 6350 (4.0)

Field Summary

Fields inherited from class ezvcard.io.StreamReader

context, index, warnings

Constructor Summary

Constructors

Constructor and Description
VCardReader(InputStream in) Creates a new vCard reader.
VCardReader(InputStream in, VCardVersion defaultVersion) Creates a new vCard reader.
VCardReader(Path file) Creates a new vCard reader.
VCardReader(Path file, VCardVersion defaultVersion) Creates a new vCard reader.
VCardReader(Reader reader) Creates a new vCard reader.
VCardReader(Reader reader, VCardVersion defaultVersion) Creates a new vCard reader.
VCardReader(String str) Creates a new vCard reader.
VCardReader(String str, VCardVersion defaultVersion) Creates a new vCard reader.

Method Summary

Modifier and Type	Method and Description
protected VCard	_readNext() Reads the next vCard from the data stream.
void	close() Closes the input stream.
Charset	getDefaultQuotedPrintableCharset() Gets the character set to use when the parser cannot determine what character set to use to decode a quoted-printable property value.
boolean	isCaretDecodingEnabled() Gets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).
void	setCaretDecodingEnabled(boolean enable) Sets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default).
void	setDefaultQuotedPrintableCharset(Charset charset) Sets the character set to use when the parser cannot determine what character set to use to decode a quoted-printable property value.

Methods inherited from class ezvcard.io.StreamReader

assignLabels, getScribeIndex, getWarnings, readAll, readNext, registerScribe, setScribeIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

VCardReader

public VCardReader(String str)

Creates a new vCard reader.

Parameters:

str - the string to read from

VCardReader

public VCardReader(String str,
                   VCardVersion defaultVersion)

Creates a new vCard reader.

Parameters:

str - the string to read from

defaultVersion - the version to assume the vCard is in until a VERSION property is encountered (defaults to 2.1)

VCardReader

public VCardReader(InputStream in)

Creates a new vCard reader.

Parameters:

in - the input stream to read from

VCardReader

public VCardReader(InputStream in,
                   VCardVersion defaultVersion)

Creates a new vCard reader.

Parameters:

in - the input stream to read from

defaultVersion - the version to assume the vCard is in until a VERSION property is encountered (defaults to 2.1)

VCardReader

public VCardReader(Path file)
            throws IOException

Creates a new vCard reader.

Parameters:

file - the file to read from

Throws:

IOException - if there is a problem opening the file

VCardReader

public VCardReader(Path file,
                   VCardVersion defaultVersion)
            throws IOException

Creates a new vCard reader.

Parameters:

file - the file to read from

defaultVersion - the version to assume the vCard is in until a VERSION property is encountered (defaults to 2.1)

Throws:

IOException - if there is a problem opening the file

VCardReader

public VCardReader(Reader reader)

Creates a new vCard reader.

Parameters:

reader - the reader to read from

VCardReader

public VCardReader(Reader reader,
                   VCardVersion defaultVersion)

Creates a new vCard reader.

Parameters:

reader - the reader to read from

defaultVersion - the version to assume the vCard is in until a VERSION property is encountered (defaults to 2.1)

Method Detail

isCaretDecodingEnabled

public boolean isCaretDecodingEnabled()

Gets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default). This escaping mechanism allows newlines and double quotes to be included in parameter values.

Returns:

true if circumflex accent decoding is enabled, false if not

See Also:

VObjectReader.isCaretDecodingEnabled()

setCaretDecodingEnabled

public void setCaretDecodingEnabled(boolean enable)

Sets whether the reader will decode parameter values that use circumflex accent encoding (enabled by default). This escaping mechanism allows newlines and double quotes to be included in parameter values.

Parameters:

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

See Also:

VObjectReader.setCaretDecodingEnabled(boolean)

getDefaultQuotedPrintableCharset

public Charset getDefaultQuotedPrintableCharset()

Gets the character set to use when the parser cannot determine what character set to use to decode a quoted-printable property value.

Returns:

the character set

See Also:

VObjectReader.getDefaultQuotedPrintableCharset()

setDefaultQuotedPrintableCharset

public void setDefaultQuotedPrintableCharset(Charset charset)

Sets the character set to use when the parser cannot determine what character set to use to decode a quoted-printable property value.

Parameters:

charset - the character set (cannot be null)

See Also:

VObjectReader.setDefaultQuotedPrintableCharset(java.nio.charset.Charset)

_readNext

protected VCard _readNext()
                   throws IOException

Description copied from class: StreamReader

Reads the next vCard from the data stream.

Specified by:

_readNext in class StreamReader

Returns:

the next vCard or null if there are no more

Throws:

IOException - if there's a problem reading from the stream

close

public void close()
           throws IOException

Closes the input stream.

Throws:

IOException - if there's a problem closing the input stream