ezvcard.property

Class Interest

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.SimpleProperty<String>

ezvcard.property.TextProperty

ezvcard.property.Interest

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

@SupportedVersions(value=V4_0)
public class Interest
extends TextProperty
implements HasAltId

Defines a recreational activity that the person is interested in. For example, if a person has an interest in "hockey", it would mean that he likes to watch hockey games. Someone who likes to actually play hockey would list hockey as a Hobby instead.

Code sample

 VCard vcard = new VCard();
 
 Interest interest = new Interest("hockey");
 interest.setLevel(InterestLevel.HIGH);
 vcard.addInterest(interest);
 

Property name: INTEREST

Supported versions: 4.0

Author:

Michael Angstadt

See Also:

RFC 6715 p.5

Field Summary

Fields inherited from class ezvcard.property.SimpleProperty

value

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Interest(Interest original) Copy constructor.
Interest(String interest) Creates an interest property.

Method Summary

Modifier and Type	Method and Description
Interest	copy() Creates a copy of this property object.
String	getAltId() Gets the property's ALTID parameter.
Integer	getIndex() Gets the sorted position of this property when it is grouped together with other properties of the same type.
String	getLanguage() Gets the language that the property value is written in.
InterestLevel	getLevel() Gets the level of the person's interest.
Integer	getPref() Gets this property's preference value.
String	getType() Gets the TYPE parameter.
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setIndex(Integer index) Sets the sorted position of this property when it is grouped together with other properties of the same type.
void	setLanguage(String language) Sets the language that the property value is written in.
void	setLevel(InterestLevel level) Sets the level of the person's interest.
void	setPref(Integer pref) Sets this property's preference value.
void	setType(String type) Sets the TYPE parameter.

Methods inherited from class ezvcard.property.SimpleProperty

_validate, equals, getValue, hashCode, setValue, toStringValues

Methods inherited from class ezvcard.property.VCardProperty

addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, isSupportedBy, removeParameter, setGroup, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Interest

public Interest(String interest)

Creates an interest property.

Parameters:

interest - the hobby (e.g. "wind surfing")

Interest

public Interest(Interest original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getLevel

public InterestLevel getLevel()

Gets the level of the person's interest.

Returns:

the interest level (e.g. "low") or null if not set

See Also:

VCardParameters.getLevel()

setLevel

public void setLevel(InterestLevel level)

Sets the level of the person's interest.

Parameters:

level - the level (e.g. "low") or null to remove

See Also:

VCardParameters.setLevel(java.lang.String)

getIndex

public Integer getIndex()

Description copied from class: VCardProperty

Gets the sorted position of this property when it is grouped together with other properties of the same type. Properties with low index values are put at the beginning of the sorted list. Properties with high index values are put at the end of the list.

Supported versions: 4.0

Returns:

the index or null if not set

See Also:

RFC 6715 p.7

setIndex

public void setIndex(Integer index)

Description copied from class: VCardProperty

Sets the sorted position of this property when it is grouped together with other properties of the same type. Properties with low index values are put at the beginning of the sorted list. Properties with high index values are put at the end of the list.

Supported versions: 4.0

Parameters:

index - the index or null to remove

See Also:

RFC 6715 p.7

getType

public String getType()

Gets the TYPE parameter.

Returns:

the TYPE value (typically, this will be either "work" or "home") or null if it doesn't exist

setType

public void setType(String type)

Sets the TYPE parameter.

Parameters:

type - the TYPE value (this should be either "work" or "home") or null to remove

getLanguage

public String getLanguage()

Description copied from class: VCardProperty

Gets the language that the property value is written in.

Returns:

the language or null if not set

setLanguage

public void setLanguage(String language)

Description copied from class: VCardProperty

Sets the language that the property value is written in.

Parameters:

language - the language or null to remove

getPref

public Integer getPref()

Description copied from class: VCardProperty

Gets this property's preference value. The lower this number is, the more "preferred" the property instance is compared with other properties of the same type. If a property doesn't have a preference value, then it is considered the least preferred.

In the vCard below, the Address on the second row is the most preferred because it has the lowest PREF value.

 ADR;TYPE=work;PREF=2:;;1600 Amphitheatre Parkway;Mountain View;CA;94043
 ADR;TYPE=work;PREF=1:;;One Microsoft Way;Redmond;WA;98052
 ADR;TYPE=home:;;123 Maple St;Hometown;KS;12345
 

Supported versions: 4.0

Returns:

the preference value or null if not set

See Also:

RFC 6350 p.17

setPref

public void setPref(Integer pref)

Description copied from class: VCardProperty

Sets this property's preference value. The lower this number is, the more "preferred" the property instance is compared with other properties of the same type. If a property doesn't have a preference value, then it is considered the least preferred.

In the vCard below, the Address on the second row is the most preferred because it has the lowest PREF value.

 ADR;TYPE=work;PREF=2:;;1600 Amphitheatre Parkway;Mountain View;CA;94043
 ADR;TYPE=work;PREF=1:;;One Microsoft Way;Redmond;WA;98052
 ADR;TYPE=home:;;123 Maple St;Hometown;KS;12345
 

Supported versions: 4.0

Parameters:

pref - the preference value or null to remove

See Also:

RFC 6350 p.17

getAltId

public String getAltId()

Description copied from interface: HasAltId

Gets the property's ALTID parameter.

Supported versions: 4.0

Specified by:

getAltId in interface HasAltId

Returns:

the ALTID or null if it doesn't exist

See Also:

VCardParameters.getAltId()

setAltId

public void setAltId(String altId)

Description copied from interface: HasAltId

Sets the property's ALTID parameter.

Supported versions: 4.0

Specified by:

setAltId in interface HasAltId

Parameters:

altId - the ALTID or null to remove

See Also:

VCardParameters.setAltId(java.lang.String)

copy

public Interest copy()

Description copied from class: VCardProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the VCardProperty.VCardProperty(VCardProperty) super constructor to ensure that the group name and parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the VCard class's copy constructor).

Overrides:

copy in class VCardProperty

Returns:

the copy