org.dmfs.rfc5545

Class Duration

java.lang.Object

org.dmfs.rfc5545.Duration

public final class Duration
extends java.lang.Object

Represents duration values as specified in RFC 5545, Section 3.3.6.

Objects of this class are immutable.

Constructor Summary

Constructors

Constructor and Description
Duration(int sign, int weeks) Create a duration of the given number of weeks.
Duration(int sign, int days, int time) Create a duration of the given day and time values.
Duration(int sign, int days, int hours, int minutes, int seconds) Create a duration of the given day and time values.

Method Summary

Modifier and Type	Method and Description
Duration	addDuration(Duration other) Add another Duration to this one and return a new Duration object.
long	addTo(java.util.TimeZone timezone, long timestamp) Add this duration to the given timestamp, taking daylight savings in the given time zone into account.
boolean	equals(java.lang.Object obj)
int	getDays() Return the days of this duration.
int	getHours() Return the hours of this duration.
int	getMinutes() Return the minutes of this duration.
int	getRawDays() Returns the actual number of days, without taking weeks into account.
int	getSeconds() Return the seconds of this duration.
int	getSecondsOfDay() Returns the time part in seconds.
int	getSign() Return the sign of this duration.
int	getWeeks() Return the weeks of this duration.
int	hashCode()
boolean	isZero() Returns whether this Duration represents zero time.
static Duration	parse(java.lang.String durationString) Parse the given Duration String to a Duration value.
long	toMillis() Returns the value of this Duration in milliseconds, assuming days of 24 hours.
java.lang.String	toString()
void	writeTo(java.lang.StringBuilder builder) Write the Duration String to the given StringBuilder.
void	writeTo(java.io.Writer writer) Write the Duration String to the given Writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Duration

public Duration(int sign,
                int weeks)

Create a duration of the given number of weeks.

Parameters:

sign - The factor that determines the sign. Must be either 1 or -1.

weeks - The number of weeks of the duration.

Duration

public Duration(int sign,
                int days,
                int hours,
                int minutes,
                int seconds)

Create a duration of the given day and time values.

Parameters:

sign - The factor that determines the sign. Must be either 1 or -1.

days - The number of days of the duration.

hours - The number of hours of the duration.

minutes - The number of minutes of the duration.

seconds - The number of seconds of the duration.

Duration

public Duration(int sign,
                int days,
                int time)

Create a duration of the given day and time values.

Parameters:

sign - The factor that determines the sign. Must be either 1 or -1.

days - The number of days of the duration.

time - The time of the duration in seconds.

Method Detail

parse

public static Duration parse(java.lang.String durationString)

Parse the given Duration String to a Duration value.

Parameters:

durationString - A String that conforms to a Duration as specified in RFC 5545, Section 3.3.6.

Returns:

A Duration instance.

Throws:

java.lang.IllegalArgumentException - if the Duration String is malformed.

isZero

public boolean isZero()

Returns whether this Duration represents zero time.

Returns:

true if all values are 0, false otherwise.

getSign

public int getSign()

Return the sign of this duration.

Returns:

Either 1 or -1.

getWeeks

public int getWeeks()

Return the weeks of this duration. This will return 0 if the number of days is not a multiple of 7 or the duration has a time part.

Returns:

The number of weeks.

getDays

public int getDays()

Return the days of this duration. This will return 0 if the number of days is a multiple of 7 and the duration has no time part.

Use getRawDays() to get the actual number of days.

Returns:

The number of days.

getRawDays

public int getRawDays()

Returns the actual number of days, without taking weeks into account. See getDays() to get the number of days as in the resulting Duration string.

Returns:

The actual number of days of this duration.

getHours

public int getHours()

Return the hours of this duration.

Returns:

The number of hours.

getMinutes

public int getMinutes()

Return the minutes of this duration.

Returns:

The number of minutes.

getSeconds

public int getSeconds()

Return the seconds of this duration.

Returns:

The number of seconds.

getSecondsOfDay

public int getSecondsOfDay()

Returns the time part in seconds. The result equals:

 getHours() * 3600 + getMinutes * 60 + getSeconds()
 

but this method is faster than calling the above.

Returns:

toMillis

public long toMillis()

Returns the value of this Duration in milliseconds, assuming days of 24 hours. This is not always correct. The actual number of milliseconds may be less if a daylight savings transition occurs in a specific interval.

Returns:

The duration in milliseconds.

addTo

public long addTo(java.util.TimeZone timezone,
                  long timestamp)

Add this duration to the given timestamp, taking daylight savings in the given time zone into account.

Parameters:

timezone - The TimeZone of the event or null in case of a floating event.

timestamp - The timestamp in milliseconds since the epoch.

Returns:

The new timestamp.

addDuration

public Duration addDuration(Duration other)

Add another Duration to this one and return a new Duration object.

Parameters:

other - The other Duration to add.

Returns:

The resulting Duration.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeTo

public void writeTo(java.lang.StringBuilder builder)

Write the Duration String to the given StringBuilder.

Parameters:

builder - A StringBuilder to write to.

writeTo

public void writeTo(java.io.Writer writer)
             throws java.io.IOException

Write the Duration String to the given Writer.

Parameters:

writer - A Writer to write to.

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object