ezvcard.parameter

Class Pid

java.lang.Object

ezvcard.parameter.Pid

public class Pid
extends Object

Represents a PID parameter value. A PID uniquely identifies a property. They are used when two different versions of the same vCard have to be merged together (called "synchronizing").

Author:

Michael Angstadt

See Also:

RFC 6350 Section 5.5

Constructor Summary

Constructors

Constructor and Description
Pid(Integer localId) Creates a new PID.
Pid(Integer localId, Integer clientPidMapReference) Creates a new PID.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Integer	getClientPidMapReference() Gets the reference to the property's globally unique ID (stored in a ClientPidMap property).
Integer	getLocalId() Gets the local ID
int	hashCode()
String	toString()
static Pid	valueOf(String value) Parses a string into a Pid object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pid

public Pid(Integer localId,
           Integer clientPidMapReference)

Creates a new PID.

Parameters:

localId - the local ID (cannot be null, must be positive)

clientPidMapReference - an integer that references the property's globally unique ID (optional, must be positive). It must match the first value in an existing ClientPidMap property

Throws:

NullPointerException - if local ID is null

Pid

public Pid(Integer localId)

Creates a new PID.

Parameters:

localId - the local ID (cannot be null, must be positive)

Throws:

NullPointerException - if local ID is null

Method Detail

getLocalId

public Integer getLocalId()

Gets the local ID

Returns:

the local ID

getClientPidMapReference

public Integer getClientPidMapReference()

Gets the reference to the property's globally unique ID (stored in a ClientPidMap property).

Returns:

the reference ID or null if not set

valueOf

public static Pid valueOf(String value)

Parses a string into a Pid object.

Parameters:

value - the string value (e.g. "1.2")

Returns:

the Pid object

Throws:

NumberFormatException - if there's a problem parsing the string

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object