net.fortuna.ical4j.vcard

Class Property

java.lang.Object

net.fortuna.ical4j.vcard.Property

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Address, Agent, BDay, Birth, CalAdrUri, CalUri, Categories, Clazz, DDay, Death, Email, FbUrl, Fn, Gender, Geo, Impp, Key, Kind, Label, Lang, Logo, Mailer, Member, N, Name, Nickname, Note, Org, Photo, ProdId, Related, Revision, Role, SortString, Sound, Source, Telephone, Title, Tz, Uid, Url, Version, XProperty

public abstract class Property
extends java.lang.Object
implements java.io.Serializable

A vCard property. $Id$ Created on 21/08/2008

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Property.Id Enumeration of property identifiers.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ILLEGAL_PARAMETER_MESSAGE

Constructor Summary

Constructors

Modifier	Constructor and Description
	Property(Group group, Property.Id id)
protected	Property(Group group, Property.Id id, java.util.List<Parameter> parameters)
	Property(Group group, java.lang.String extendedName)
	Property(Group group, java.lang.String extendedName, java.util.List<Parameter> parameters)
	Property(Property.Id id)
protected	Property(Property.Id id, java.util.List<Parameter> parameters)
	Property(java.lang.String extendedName)
	Property(java.lang.String extendedName, java.util.List<Parameter> parameters)

Method Summary

Modifier and Type	Method and Description
protected void	assertOneOrLess(Parameter.Id paramId)
protected void	assertParametersEmpty()
protected void	assertPidParameter(Parameter param)
protected void	assertPrefParameter(Parameter param)
protected void	assertTextParameter(Parameter param)
protected void	assertTypeParameter(Parameter param)
boolean	equals(java.lang.Object obj)
Parameter	getExtendedParameter(java.lang.String name) Returns the first non-standard parameter with a matching name.
java.util.List<Parameter>	getExtendedParameters(java.lang.String name) Returns a list of non-standard parameters matching the specified name.
Group	getGroup()
Property.Id	getId()
Parameter	getParameter(Parameter.Id id) Returns the first parameter with a matching identifier.
java.util.List<Parameter>	getParameters()
java.util.List<Parameter>	getParameters(Parameter.Id id) Returns a list of parameters matching the specified identifier.
abstract java.lang.String	getValue()
int	hashCode()
java.lang.String	toString()
abstract void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

ILLEGAL_PARAMETER_MESSAGE

protected static final java.lang.String ILLEGAL_PARAMETER_MESSAGE

See Also:

Constant Field Values

Constructor Detail

Property

public Property(java.lang.String extendedName)

Parameters:

extendedName - a non-standard property name

Property

public Property(Group group,
                java.lang.String extendedName)

Parameters:

group - a property group

extendedName - the non-standard property name

Property

public Property(java.lang.String extendedName,
                java.util.List<Parameter> parameters)

Parameters:

extendedName - a non-standard property name

parameters - property parameters

Property

public Property(Group group,
                java.lang.String extendedName,
                java.util.List<Parameter> parameters)

Parameters:

group - a property group

extendedName - the non-standard property name

parameters - property parameters

Property

public Property(Property.Id id)

Parameters:

id - the property type

Property

public Property(Group group,
                Property.Id id)

Parameters:

group - a property group

id - a standard property identifier

Property

protected Property(Property.Id id,
                   java.util.List<Parameter> parameters)

Parameters:

id - a standard property identifier

parameters - property parameters

Property

protected Property(Group group,
                   Property.Id id,
                   java.util.List<Parameter> parameters)

Parameters:

group - a property group

id - a standard property identifier

parameters - property parameters

Method Detail

getGroup

public final Group getGroup()

Returns:

the group

getId

public final Property.Id getId()

Returns:

the id

getParameters

public final java.util.List<Parameter> getParameters()

Returns:

the parameters

getParameters

public final java.util.List<Parameter> getParameters(Parameter.Id id)

Returns a list of parameters matching the specified identifier.

Parameters:

id - a parameter identifier

Returns:

a list of parameters

getParameter

public final Parameter getParameter(Parameter.Id id)

Returns the first parameter with a matching identifier.

Parameters:

id - a parameter identifier

Returns:

the first matching parameter, or null if no parameters with the specified identifier are found

getExtendedParameters

public final java.util.List<Parameter> getExtendedParameters(java.lang.String name)

Returns a list of non-standard parameters matching the specified name.

Parameters:

name - a non-standard parameter name

Returns:

a list of parameters

getExtendedParameter

public final Parameter getExtendedParameter(java.lang.String name)

Returns the first non-standard parameter with a matching name.

Parameters:

name - a non-standard parameter name

Returns:

the first matching parameter, or null if no non-standard parameters with the specified name are found

getValue

public abstract java.lang.String getValue()

Returns:

a string representaion of the property propertyName

validate

public abstract void validate()
                       throws net.fortuna.ical4j.model.ValidationException

Throws:

net.fortuna.ical4j.model.ValidationException - where the property fails validation rules

assertParametersEmpty

protected final void assertParametersEmpty()
                                    throws net.fortuna.ical4j.model.ValidationException

Throws:

net.fortuna.ical4j.model.ValidationException - where the parameter list is not empty

assertTextParameter

protected final void assertTextParameter(Parameter param)
                                  throws net.fortuna.ical4j.model.ValidationException

Parameters:

param - a parameter to validate

Throws:

net.fortuna.ical4j.model.ValidationException - where the specified parameter is not a text parameter

assertTypeParameter

protected final void assertTypeParameter(Parameter param)
                                  throws net.fortuna.ical4j.model.ValidationException

Parameters:

param - a parameter to validate

Throws:

net.fortuna.ical4j.model.ValidationException - where the specified parameter is not a type parameter

assertPidParameter

protected final void assertPidParameter(Parameter param)
                                 throws net.fortuna.ical4j.model.ValidationException

Parameters:

param - a parameter to validate

Throws:

net.fortuna.ical4j.model.ValidationException - where the specified parameter is not a PID parameter

assertPrefParameter

protected final void assertPrefParameter(Parameter param)
                                  throws net.fortuna.ical4j.model.ValidationException

Parameters:

param - a parameter to validate

Throws:

net.fortuna.ical4j.model.ValidationException - where the specified parameter is not a Pref parameter

assertOneOrLess

protected final void assertOneOrLess(Parameter.Id paramId)
                              throws net.fortuna.ical4j.model.ValidationException

Parameters:

paramId - a parameter identifier to validate from

Throws:

net.fortuna.ical4j.model.ValidationException - where there is not one or less of the specified parameter in the parameter list

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a vCard-compliant string representation of the property