Package net.fortuna.ical4j.model.property

Class Description

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Description

All Implemented Interfaces:

Serializable, Comparable<Property>, Encodable, FluentProperty

public class Description
extends Property
implements Encodable

$Id$

Created: [Apr 6, 2004]

Defines a DESCRIPTION iCalendar component property.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Description.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

Constructor Summary

Constructors

Constructor	Description
Description()	Default constructor.
Description(String aValue)
Description(ParameterList aList, String aValue)

Method Summary

Modifier and Type	Method	Description
String	getValue()
protected PropertyFactory<Description>	newFactory()	Returns a new property factory used to create deep copies.
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, getParameterList, getParameters, getRequiredParameter, hashCode, remove, removeAll, replace, setParameters, 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 Detail

Description

public Description()

Default constructor.

Description

public Description(String aValue)

Parameters:

aValue - a value string for this component

Description

public Description(ParameterList aList,
                   String aValue)

Parameters:

aList - a list of parameters for this component

aValue - a value string for this component

Method Detail

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

Description copied from class: Property

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<Description> 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