Module ical4j.core

Package net.fortuna.ical4j.model.property

Class XProperty

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.XProperty

All Implemented Interfaces:

Serializable, Comparable<Property>, Encodable, FluentProperty, Prototype<Property>

public class XProperty
extends Property
implements Encodable

$Id$ Created: [15/06/2004] Defines an extension property.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.fortuna.ical4j.model.Content

Content.Factory

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML

Constructor Summary

Constructors

Constructor	Description
XProperty(String name)	Constructs an uninitialised non-standard property.
XProperty(String aName, String aValue)
XProperty(String aName, ParameterList aList, String aValue)

Method Summary

Modifier and Type	Method	Description
final String	getValue()
protected PropertyFactory<XProperty>	newFactory()	Returns a new property factory used to create deep copies.
final void	setValue(String aValue)	Sets the current value of the property.
ValidationResult	validate()	Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.Property

add, compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameter, getParameterList, getParameters, getPrefix, getRequiredParameter, getRequiredParameter, hashCode, remove, removeAll, replace, setParameters, setPrefix, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

Constructor Details

XProperty

public XProperty(String name)

Constructs an uninitialised non-standard property.

Parameters:

name - a non-standard property name

XProperty

public XProperty(String aName,
 String aValue)

Parameters:

aName - a non-standard property name

aValue - a property value

XProperty

public XProperty(String aName,
 ParameterList aList,
 String aValue)

Parameters:

aName - a non-standard property name

aList - a list of parameters

aValue - a property value

Method Details

setValue

public final void setValue(String aValue)

Sets the current value of the property.

Specified by:

setValue in class Property

Parameters:

aValue - a string representation of the property value

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

validate

public ValidationResult validate()
                          throws ValidationException

Perform validation on a property.

Specified by:

validate in class Property

Throws:

ValidationException - where the property is not in a valid state

newFactory

protected PropertyFactory<XProperty> newFactory()

Description copied from class: Property

Returns a new property factory used to create deep copies.

Specified by:

newFactory in class Property

Returns:

a property factory instance