net.fortuna.ical4j.model.property
Class Duration
java.lang.Object
net.fortuna.ical4j.model.Content
net.fortuna.ical4j.model.Property
net.fortuna.ical4j.model.property.Duration
- All Implemented Interfaces:
- Serializable
- public class Duration
- extends Property
Defines a DURATION iCalendar component property.
4.3.6 Duration
Value Name: DURATION
Purpose: This value type is used to identify properties that contain
a duration of time.
Formal Definition: The value type is defined by the following
notation:
dur-value = (["+"] / "-") "P" (dur-date / dur-time / dur-week)
dur-date = dur-day [dur-time]
dur-time = "T" (dur-hour / dur-minute / dur-second)
dur-week = 1*DIGIT "W"
dur-hour = 1*DIGIT "H" [dur-minute]
dur-minute = 1*DIGIT "M" [dur-second]
dur-second = 1*DIGIT "S"
dur-day = 1*DIGIT "D"
Description: If the property permits, multiple "duration" values are
specified by a COMMA character (US-ASCII decimal 44) separated list
of values. The format is expressed as the [ISO 8601] basic format for
the duration of time. The format can represent durations in terms of
weeks, days, hours, minutes, and seconds.
No additional content value encoding (i.e., BACKSLASH character
encoding) are defined for this value type.
Example: A duration of 15 days, 5 hours and 20 seconds would be:
P15DT5H0M20S
A duration of 7 weeks would be:
P7W
- Author:
- Ben Fortuna
- See Also:
- Serialized Form
Fields inherited from class net.fortuna.ical4j.model.Property |
ACTION, ATTACH, ATTENDEE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, FREEBUSY, GEO, LAST_MODIFIED, LOCATION, METHOD, ORGANIZER, PERCENT_COMPLETE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, SUMMARY, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION |
Duration
public Duration()
- Default constructor.
Duration
public Duration(ParameterList aList,
String aValue)
- Parameters:
aList
- a list of parameters for this componentaValue
- a value string for this component
Duration
public Duration(Dur duration)
- Parameters:
duration
-
Duration
public Duration(ParameterList aList,
Dur duration)
- Parameters:
aList
- a list of parameters for this component
Duration
public Duration(Date start,
Date end)
- Constructs a new duration representing the time
between the specified start date and end date.
- Parameters:
start
- the starting time for the durationend
- the end time for the duration
getDuration
public final Dur getDuration()
- Returns:
- Returns the duration.
setValue
public final void setValue(String aValue)
- Description copied from class:
Property
- 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 Property
- Returns:
- Returns the value.
setDuration
public final void setDuration(Dur duration)
- Parameters:
duration
- The duration to set.
validate
public final void 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