ezvcard.property

Class Note

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.SimpleProperty<String>

ezvcard.property.TextProperty

ezvcard.property.Note

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class Note
extends TextProperty
implements HasAltId

Defines a free-form text field that contains miscellaneous information.

Code sample

 VCard vcard = new VCard();
 
 Note note = new Note("This is a\nnote property.");
 vcard.addNote(note);
 

Property name: NOTE

Supported versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

See Also:

RFC 6350 p.44, RFC 2426 p.21, vCard 2.1 p.19

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
Note(Note original) Copy constructor.
Note(String note) Creates a note property.

Method Summary

Modifier and Type	Method and Description
Note	copy() Creates a copy of this property object.
String	getAltId() Gets the property's ALTID parameter.
String	getLanguage() Gets the language that the property value is written in.
List<Pid>	getPids() Gets the list that stores this property's PID (property ID) parameter values.
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	setLanguage(String language) Sets the language that the property value is written in.
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

Note

public Note(String note)

Creates a note property.

Parameters:

note - the note text

Note

public Note(Note original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getPids

public List<Pid> getPids()

Description copied from class: VCardProperty

Gets the list that stores this property's PID (property ID) parameter values.

PIDs can exist on any property where multiple instances are allowed (such as Email or Address, but not StructuredName because only 1 instance of this property is allowed per vCard).

When used in conjunction with the ClientPidMap property, it allows an individual property instance to be uniquely identifiable. This feature is made use of when two different versions of the same vCard have to be merged together (called "synchronizing").

Supported versions: 4.0

Returns:

the PID parameter values (this list is mutable)

See Also:

RFC 6350 p.19

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)

getType

public String getType()

Gets the TYPE parameter.

Supported versions: 4.0

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.

Supported versions: 4.0

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

copy

public Note 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