com.aspose.email

Class VCardContact

java.lang.Object

com.aspose.email.VCardContact

public final class VCardContact
extends Object

Represents a vCard contact

Constructor Summary

Constructors

Constructor and Description
VCardContact() Initializes a new instance of the VCardContact class

Method Summary

Methods

Modifier and Type	Method and Description
VCardDeliveryAddressCollection	getDeliveryAddresses() Gets or sets a delivery addresses
VCardEmailCollection	getEmails() Gets or sets a contact's email addresses
VCardExplanatoryInfo	getExplanatoryInfo() Gets or sets a vCard explanatory information
StringCollection	getExtendedProperties() Gets or sets an extended properties
VCardGeo	getGeo() Gets or sets a global positioning
VCardIdentificationInfo	getIdentificationInfo() Gets or sets an identification properties
VCardLabelCollection	getLabels() Gets or sets a delivery addresses
String	getMailer() Gets or sets a mailer
VCardOrganization	getOrganization() Gets or sets an organization information
VCardSecurity	getSecurity() Gets or sets a security properites
VCardTelephoneNumberCollection	getTelephoneNumbers() Gets or sets a contact's telephone numbers
String	getTimeZone() Gets or sets a timeZone
static boolean	isMultiContacts(InputStream stream) Checks whether source stream contains multi contacts.
static boolean	isMultiContacts(String filePath) Checks whether source file contains multi contacts.
static VCardContact	load(InputStream stream) Reads VCardContact from the specified stream containing vCard.
static VCardContact	load(InputStream stream, Charset encoding) Reads VCardContact from the specified stream containing vCard.
static VCardContact	load(String filePath) Reads VCardContact from the specified vCard file The supported vCard versions are 2.1 and 3.0
static VCardContact	load(String filePath, Charset encoding) Reads VCardContact from the specified vCard file The supported vCard versions are 2.1 and 3.0
static List<VCardContact>	loadAsMultiple(InputStream stream) Loads list of contacts from multi contact stream.
static List<VCardContact>	loadAsMultiple(InputStream stream, Charset encoding) Deprecated. Tthis method is obsolete and will be removed soon. Use LoadAsMultiple(Stream stream, VCardLoadOptions options) method instead of it.
static List<VCardContact>	loadAsMultiple(InputStream stream, VCardLoadOptions options) Loads list of contacts from multi contact stream.
static List<VCardContact>	loadAsMultiple(String filePath) Loads list of contacts from multi contact file.
static List<VCardContact>	loadAsMultiple(String filePath, Charset encoding) Deprecated. Tthis method is obsolete and will be removed soon. Use LoadAsMultiple(string filePath, VCardLoadOptions options) method instead of it.
static List<VCardContact>	loadAsMultiple(String filePath, VCardLoadOptions options)
void	save(OutputStream stream) Saves this MapiContact into the given stream with vCard format.
void	save(OutputStream stream, ContactSaveOptions saveOptions) Saves this MapiContact to the given stream using specified save options.
void	save(OutputStream stream, int saveFormat) Saves this MapiContact to the given stream with a format using the default options.
void	save(String filePath) Saves this MapiContact to the vCard file with a default options.
void	save(String filePath, ContactSaveOptions saveOptions) Saves this MapiContact into file using specified save options.
void	save(String filePath, int saveFormat) Saves this MapiContact to the specified file with a format using the default options.
void	setDeliveryAddresses(VCardDeliveryAddressCollection value) Gets or sets a delivery addresses
void	setEmails(VCardEmailCollection value) Gets or sets a contact's email addresses
void	setExplanatoryInfo(VCardExplanatoryInfo value) Gets or sets a vCard explanatory information
void	setExtendedProperties(StringCollection value) Gets or sets an extended properties
void	setGeo(VCardGeo value) Gets or sets a global positioning
void	setIdentificationInfo(VCardIdentificationInfo value) Gets or sets an identification properties
void	setLabels(VCardLabelCollection value) Gets or sets a delivery addresses
void	setMailer(String value) Gets or sets a mailer
void	setOrganization(VCardOrganization value) Gets or sets an organization information
void	setSecurity(VCardSecurity value) Gets or sets a security properites
void	setTelephoneNumbers(VCardTelephoneNumberCollection value) Gets or sets a contact's telephone numbers
void	setTimeZone(String value) Gets or sets a timeZone

Methods inherited from class java.lang.Object

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

Constructor Detail

VCardContact

public VCardContact()

Initializes a new instance of the VCardContact class

Method Detail

getIdentificationInfo

public final VCardIdentificationInfo getIdentificationInfo()

Gets or sets an identification properties

setIdentificationInfo

public final void setIdentificationInfo(VCardIdentificationInfo value)

Gets or sets an identification properties

getDeliveryAddresses

public final VCardDeliveryAddressCollection getDeliveryAddresses()

Gets or sets a delivery addresses

setDeliveryAddresses

public final void setDeliveryAddresses(VCardDeliveryAddressCollection value)

Gets or sets a delivery addresses

getLabels

public final VCardLabelCollection getLabels()

Gets or sets a delivery addresses

setLabels

public final void setLabels(VCardLabelCollection value)

Gets or sets a delivery addresses

getTelephoneNumbers

public final VCardTelephoneNumberCollection getTelephoneNumbers()

Gets or sets a contact's telephone numbers

setTelephoneNumbers

public final void setTelephoneNumbers(VCardTelephoneNumberCollection value)

Gets or sets a contact's telephone numbers

getEmails

public final VCardEmailCollection getEmails()

Gets or sets a contact's email addresses

setEmails

public final void setEmails(VCardEmailCollection value)

Gets or sets a contact's email addresses

getMailer

public final String getMailer()

Gets or sets a mailer

setMailer

public final void setMailer(String value)

Gets or sets a mailer

getTimeZone

public final String getTimeZone()

Gets or sets a timeZone

setTimeZone

public final void setTimeZone(String value)

Gets or sets a timeZone

getGeo

public final VCardGeo getGeo()

Gets or sets a global positioning

setGeo

public final void setGeo(VCardGeo value)

Gets or sets a global positioning

getOrganization

public final VCardOrganization getOrganization()

Gets or sets an organization information

setOrganization

public final void setOrganization(VCardOrganization value)

Gets or sets an organization information

getExplanatoryInfo

public final VCardExplanatoryInfo getExplanatoryInfo()

Gets or sets a vCard explanatory information

setExplanatoryInfo

public final void setExplanatoryInfo(VCardExplanatoryInfo value)

Gets or sets a vCard explanatory information

getSecurity

public final VCardSecurity getSecurity()

Gets or sets a security properites

setSecurity

public final void setSecurity(VCardSecurity value)

Gets or sets a security properites

getExtendedProperties

public final StringCollection getExtendedProperties()

Gets or sets an extended properties

setExtendedProperties

public final void setExtendedProperties(StringCollection value)

Gets or sets an extended properties

load

public static VCardContact load(String filePath)

Reads VCardContact from the specified vCard file The supported vCard versions are 2.1 and 3.0

Parameters:

filePath - A file name to read from

Returns:

A read VCardContact

Throws:

ArgumentException - filePath is null or empty

load

public static VCardContact load(String filePath,
                Charset encoding)

Reads VCardContact from the specified vCard file The supported vCard versions are 2.1 and 3.0

Parameters:

filePath - A file name to read from

encoding - File encoding

Returns:

A read VCardContact

Throws:

ArgumentException - filePath is null or empty

load

public static VCardContact load(InputStream stream)

Reads VCardContact from the specified stream containing vCard. The supported vCard versions are 2.1 and 3.0

Parameters:

stream - A stream to read from

Returns:

A read VCardContact

Throws:

ArgumentNullException - stream is null

NotSupportedException - stream does not support reading

load

public static VCardContact load(InputStream stream,
                Charset encoding)

Reads VCardContact from the specified stream containing vCard. The supported vCard versions are 2.1 and 3.0

Parameters:

stream - A stream to read from

encoding - Stream data encoding

Returns:

A read VCardContact

Throws:

ArgumentNullException - stream is null

NotSupportedException - stream does not support reading

isMultiContacts

public static boolean isMultiContacts(String filePath)

Checks whether source file contains multi contacts.

Parameters:

filePath - Path to source file

Returns:

True if multi contacts, otherwise false.

isMultiContacts

public static boolean isMultiContacts(InputStream stream)

Checks whether source stream contains multi contacts.

Parameters:

stream - Source stream

Returns:

True if multi contacts, otherwise false.

loadAsMultiple

public static List<VCardContact> loadAsMultiple(InputStream stream)

Loads list of contacts from multi contact stream.

Parameters:

stream - Source stream

Returns:

List of contacs

loadAsMultiple

@Deprecated
public static List<VCardContact> loadAsMultiple(InputStream stream,
                                           Charset encoding)

Deprecated. Tthis method is obsolete and will be removed soon. Use LoadAsMultiple(Stream stream, VCardLoadOptions options) method instead of it.

Loads list of contacts from multi contact stream.

Parameters:

stream - Source stream

encoding - Stream data encoding,if null then UTF8 will be used.

Returns:

List of contacts

loadAsMultiple

public static List<VCardContact> loadAsMultiple(InputStream stream,
                                VCardLoadOptions options)

Loads list of contacts from multi contact stream.

Parameters:

stream - Source stream

options - Additional options when loading a VCardContact

Returns:

List of contacts

Throws:

ArgumentNullException - Throws if stream is null

NotSupportedException - Throws if the stream is not readable

loadAsMultiple

public static List<VCardContact> loadAsMultiple(String filePath)

Loads list of contacts from multi contact file.

Parameters:

filePath - Source file

Returns:

List of contacts

loadAsMultiple

@Deprecated
public static List<VCardContact> loadAsMultiple(String filePath,
                                           Charset encoding)

Deprecated. Tthis method is obsolete and will be removed soon. Use LoadAsMultiple(string filePath, VCardLoadOptions options) method instead of it.

Loads list of contacts from multi contact file.

Parameters:

filePath - Source file

encoding - File data encoding,if null then UTF8 will be used.

Returns:

List of contacts

loadAsMultiple

public static List<VCardContact> loadAsMultiple(String filePath,
                                VCardLoadOptions options)

Parameters:

filePath - Source file

options - Additional options when loading a VCardContact

Returns:

List of contacts

Throws:

ArgumentException - Throws if filePath is null or empty

save

public final void save(String filePath)

Saves this MapiContact to the vCard file with a default options. The supported vCard version is 2.1

Parameters:

filePath - A vCard file name

Throws:

ArgumentException - filePath is null or empty

save

public final void save(String filePath,
        int saveFormat)

Saves this MapiContact to the specified file with a format using the default options. The supported save format is vCard.

Parameters:

filePath - A vCard file name

saveFormat - A save format

Throws:

ArgumentException - filePath is null or empty

NotSupportedException - the specified format is not supported

save

public final void save(String filePath,
        ContactSaveOptions saveOptions)

Saves this MapiContact into file using specified save options. The supported save options is VCardSaveOptions

Parameters:

filePath - A vCard file name

saveOptions - A save options

Throws:

ArgumentException - filePath is null or empty

ArgumentNullException - saveOptions is null

NotSupportedException - some save option is not supported

save

public final void save(OutputStream stream)

Saves this MapiContact into the given stream with vCard format. The supported vCard version is 2.1

Parameters:

stream - A stream to save to

Throws:

ArgumentNullException - stream is null

NotSupportedException - stream does not support writing

save

public final void save(OutputStream stream,
        int saveFormat)

Saves this MapiContact to the given stream with a format using the default options. The supported save format is vCard

Parameters:

stream - A stream to save to

saveFormat - A save format

Throws:

ArgumentNullException - stream is null

NotSupportedException - stream does not support writing

NotSupportedException - The specified format is not supported

save

public final void save(OutputStream stream,
        ContactSaveOptions saveOptions)

Saves this MapiContact to the given stream using specified save options. The supported save options is VCardSaveOptions

Parameters:

stream - A stream to save to

saveOptions - A save options

Throws:

ArgumentNullException - stream or saveOptions is null

NotSupportedException - stream does not support writing

ArgumentException - incorrect saveOptions

NotSupportedException - some save option is not supported