net.fortuna.ical4j.model.property

Class Duration


public class Duration
extends Property

$Id: Duration.java,v 1.13 2008/12/16 12:34:51 fortuna Exp $ Created: [Apr 6, 2004] 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
 

Constructor Summary

Duration()
Default constructor.
Duration(Date start, Date end)
Constructs a new duration representing the time between the specified start date and end date.
Duration(Dur duration)
Duration(ParameterList aList, Dur duration)
Duration(ParameterList aList, String aValue)

Method Summary

Dur
getDuration()
String
getValue()
void
setDuration(Dur duration)
void
setValue(String aValue)
void
validate()

Constructor Details

Duration

public Duration()
Default constructor.

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 duration
end - the end time for the duration

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(ParameterList aList,
                String aValue)
Parameters:
aList - a list of parameters for this component
aValue - a value string for this component

Method Details

getDuration

public final Dur getDuration()
Returns:
Returns the duration.

getValue

public final String getValue()

setDuration

public final void setDuration(Dur duration)
Parameters:
duration - The duration to set.

setValue

public final void setValue(String aValue)

validate

public final void validate()
            throws ValidationException