ezvcard.property

Class Agent

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.Agent

All Implemented Interfaces:

Comparable<VCardProperty>

@SupportedVersions(value={V2_1,V3_0})
public class Agent
extends VCardProperty

Defines information about the person's agent.

Code sample (creating)

 VCard vcard = new VCard();
 
 //URL
 Agent agent = new Agent("http://www.linkedin.com/BobSmith");
 vcard.setAgent(agent);
 
 //vCard
 VCard agentVCard = new VCard();
 agentVCard.setFormattedName("Bob Smith");
 agentVCard.addTelephoneNumber("(555) 123-4566");
 agentVCard.addUrl("http://www.linkedin.com/BobSmith");
 agent = new Agent(agentVCard);
 vcard.setAgent(agent);
 

Code sample (retrieving)

 VCard vcard = ...
 Agent agent = vcard.getAgent();
 
 String url = agent.getUrl();
 if (url != null) {
   //property value is a URL
 }
 
 VCard agentVCard = agent.getVCard();
 if (agentVCard != null) {
   //property value is a vCard
 }
 

Property name: AGENT

Supported versions: 2.1, 3.0

Author:

Michael Angstadt

See Also:

RFC 2426 p.19, vCard 2.1 p.18

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Agent() Creates an empty agent property.
Agent(Agent original) Copy constructor.
Agent(String url) Creates an agent property.
Agent(VCard vcard) Creates an agent property.

Method Summary

Modifier and Type	Method and Description
protected void	_validate(List<ValidationWarning> warnings, VCardVersion version, VCard vcard) Checks the property for data consistency problems or deviations from the spec.
Agent	copy() Creates a copy of this property object.
boolean	equals(Object obj)
String	getUrl() Gets the URL to the agent's information.
VCard	getVCard() Gets an embedded vCard with the agent's information.
int	hashCode()
void	setUrl(String url) Sets the URL to the agent's information.
void	setVCard(VCard vcard) Sets an embedded vCard with the agent's information.
protected Map<String,Object>	toStringValues() Gets string representations of the class's fields for the VCardProperty.toString() method.

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

Agent

public Agent()

Creates an empty agent property.

Agent

public Agent(String url)

Creates an agent property.

Parameters:

url - a URL pointing to the agent's information

Agent

public Agent(VCard vcard)

Creates an agent property.

Parameters:

vcard - a vCard containing the agent's information

Agent

public Agent(Agent original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getUrl

public String getUrl()

Gets the URL to the agent's information.

Returns:

the URL or null if not set

setUrl

public void setUrl(String url)

Sets the URL to the agent's information.

Parameters:

url - the URL

getVCard

public VCard getVCard()

Gets an embedded vCard with the agent's information.

Returns:

the vCard or null if not set

setVCard

public void setVCard(VCard vcard)

Sets an embedded vCard with the agent's information.

Parameters:

vcard - the vCard

_validate

protected void _validate(List<ValidationWarning> warnings,
                         VCardVersion version,
                         VCard vcard)

Description copied from class: VCardProperty

Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes that wish to provide validation logic.

Overrides:

_validate in class VCardProperty

Parameters:

warnings - the list to add the warnings to

version - the version to check the property against

vcard - the vCard this property belongs to

toStringValues

protected Map<String,Object> toStringValues()

Description copied from class: VCardProperty

Gets string representations of the class's fields for the VCardProperty.toString() method.

Meant to be overridden by child classes. The default implementation returns an empty map.

Overrides:

toStringValues in class VCardProperty

Returns:

the values of the class's fields (key = field name, value = field value)

copy

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

hashCode

public int hashCode()

Overrides:

hashCode in class VCardProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class VCardProperty