Created: [Apr 6, 2004]
Defines a DURATION iCalendar component property.
3.3.6. Duration Value Name: DURATION Purpose: This value type is used to identify properties that contain a duration of time. Format Definition: This 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-separated list of values. The format is based on the [ISO.8601.2004] complete representation basic format with designators for the duration of time. The format can represent nominal durations (weeks and days) and accurate durations (hours, minutes, and seconds). Note that unlike [ISO.8601.2004], this value type doesn't support the "Y" and "M" designators to specify durations in terms of years and months. The duration of a week or a day depends on its position in the calendar. In the case of discontinuities in the time scale, such as the change from standard time to daylight time and back, the computation of the exact duration requires the subtraction or addition of the change of duration of the discontinuity. Leap seconds MUST NOT be considered when computing an exact duration. When computing an exact duration, the greatest order time components MUST be added first, that is, the number of days MUST be added first, followed by the number of hours, number of minutes, and number of seconds. Negative durations are typically used to schedule an alarm to trigger before an associated time (see Section 3.8.6.3). No additional content value encoding (i.e., BACKSLASH character encoding, see Section 3.3.11) 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
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private TemporalAmountAdapter | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | Duration(final ParameterList
a list of parameters for this component aList, final String a value string for this component aValue)
|
| public | |
| public | |
| public | Duration(final ParameterList
a list of parameters for this component aList, final Dur a duration value duration)
Deprecated
|
| public | Duration(final ParameterList
a list of parameters for this component aList, final TemporalAmount a duration value duration)
|
| public | Duration(final Date
the starting time for the duration start, final Date the end time for the duration end)
Deprecated
use
Duration#Duration(Temporal, Temporal)
Constructs a new duration representing the time between the specified start date and end date. |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public final TemporalAmount | |
| public final String | |
| protected PropertyFactory | newFactory()
Implements abstract net. Returns a new property factory used to create deep copies. |
| public final void | |
| public final void | setValue(final String
a string representation of the property value aValue)Implements abstract net. Sets the current value of the property. |
| public ValidationResult | validate()
Implements abstract net. Perform validation on a property. |
| duration | back to summary |
|---|---|
| private TemporalAmountAdapter duration | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Duration | back to summary |
|---|---|
| public Duration() Default constructor. | |
| Duration | back to summary |
|---|---|
| public Duration(String value) | |
| Duration | back to summary |
|---|---|
public Duration(final ParameterList aList, final String aValue)
| |
| Duration | back to summary |
|---|---|
| public Duration(final Dur duration)
Deprecated
| |
| Duration | back to summary |
|---|---|
public Duration(final TemporalAmount duration)
| |
| Duration | back to summary |
|---|---|
| public Duration(final ParameterList aList, final Dur duration)
Deprecated
| |
| Duration | back to summary |
|---|---|
public Duration(final ParameterList aList, final TemporalAmount duration)
| |
| Duration | back to summary |
|---|---|
| public Duration(final Date start, final Date end)
Deprecated Constructs a new duration representing the time between the specified start date and end date.
| |
| Duration | back to summary |
|---|---|
| public Duration(final Temporal start, final Temporal end) Constructs a new duration representing the time between the specified start date and end date. | |
| getDuration | back to summary |
|---|---|
public final TemporalAmount getDuration()
| |
| getValue | back to summary |
|---|---|
| public final String getValue() Implements abstract net.
| |
| newFactory | back to summary |
|---|---|
| protected PropertyFactory Implements abstract net. Doc from net. Returns a new property factory used to create deep copies.
| |
| setDuration | back to summary |
|---|---|
public final void setDuration(final TemporalAmount duration)
| |
| setValue | back to summary |
|---|---|
| public final void setValue(final String aValue) Implements abstract net. Doc from net. Sets the current value of the property. | |
| validate | back to summary |
|---|---|
| public ValidationResult validate() throws ValidationException Implements abstract net. Doc from net. Perform validation on a property.
| |
| Modifier and Type | Field and Description |
|---|---|
| private static final long |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public Duration | createProperty(final ParameterList
a list of property parameters parameters, final String a property value value)Implements net.
|
| public Duration |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Factory | back to summary |
|---|---|
| public Factory() | |
| createProperty | back to summary |
|---|---|
| public Duration createProperty(final ParameterList parameters, final String value) Implements net.
| |
| createProperty | back to summary |
|---|---|
| public Duration createProperty() Implements net.
| |