net.fortuna.ical4j.model

Class Dur

java.lang.Object

net.fortuna.ical4j.model.Dur

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Dur>

public class Dur
extends java.lang.Object
implements java.lang.Comparable<Dur>, java.io.Serializable

$Id$ Created on 20/06/2005 Represents a duration of time in iCalendar. Note that according to RFC2445 durations represented in weeks are mutually exclusive of other duration fields.

  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"
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Dur(java.util.Date date1, java.util.Date date2) Constructs a new duration representing the time between the two specified dates.
Dur(int weeks) Constructs a new duration from the specified weeks.
Dur(int days, int hours, int minutes, int seconds) Constructs a new duration from the specified arguments.
Dur(java.lang.String value) Constructs a new duration instance from a string representation.

Method Summary

Modifier and Type	Method and Description
Dur	add(Dur duration) Add two durations.
int	compareTo(Dur arg0) Compares this duration with another, acording to their length.
boolean	equals(java.lang.Object obj)
int	getDays()
int	getHours()
int	getMinutes()
int	getSeconds()
java.util.Date	getTime(java.util.Date start) Returns a date representing the end of this duration from the specified start date.
int	getWeeks()
int	hashCode()
boolean	isNegative()
Dur	negate() Provides a negation of this instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Dur

public Dur(java.lang.String value)

Constructs a new duration instance from a string representation.

Parameters:

value - a string representation of a duration

Dur

public Dur(int weeks)

Constructs a new duration from the specified weeks.

Parameters:

weeks - a duration in weeks.

Dur

public Dur(int days,
           int hours,
           int minutes,
           int seconds)

Constructs a new duration from the specified arguments.

Parameters:

days - duration in days

hours - duration in hours

minutes - duration in minutes

seconds - duration in seconds

Dur

public Dur(java.util.Date date1,
           java.util.Date date2)

Constructs a new duration representing the time between the two specified dates. The end date may precede the start date in order to represent a negative duration.

Parameters:

date1 - the first date of the duration

date2 - the second date of the duration

Method Detail

getTime

public final java.util.Date getTime(java.util.Date start)

Returns a date representing the end of this duration from the specified start date.

Parameters:

start - the date to start the duration

Returns:

the end of the duration as a date

negate

public final Dur negate()

Provides a negation of this instance.

Returns:

a Dur instance that represents a negation of this instance

add

public final Dur add(Dur duration)

Add two durations. Durations may only be added if they are both positive or both negative durations.

Parameters:

duration - the duration to add to this duration

Returns:

a new instance representing the sum of the two durations.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public final int compareTo(Dur arg0)

Compares this duration with another, acording to their length.

Specified by:

compareTo in interface java.lang.Comparable<Dur>

Parameters:

arg0 - another duration instance

Returns:

a postive value if this duration is longer, zero if the duration lengths are equal, otherwise a negative value

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDays

public final int getDays()

Returns:

Returns the days.

getHours

public final int getHours()

Returns:

Returns the hours.

getMinutes

public final int getMinutes()

Returns:

Returns the minutes.

isNegative

public final boolean isNegative()

Returns:

Returns the negative.

getSeconds

public final int getSeconds()

Returns:

Returns the seconds.

getWeeks

public final int getWeeks()

Returns:

Returns the weeks.