net.time4j

Class Duration.Builder

java.lang.Object

net.time4j.Duration.Builder

Enclosing class:

Duration<U extends IsoUnit>

public static class Duration.Builder
extends java.lang.Object

Builder class for constructing a duration conforming to ISO-8601 which consists of years, months, days and any wall time units.

The week unit is not possible in builder because this unit should be stand-alone according to ISO-8601. A week-based duration can be created by expression Duration.of(amount, CalendarUnit.WEEKS) however.

A builder instance must be created by Duration.ofPositive() or Duration.ofNegative(). Note that the builder is only be designed for single-thread-environments that is always creating a new builder instance per thread.

Method Summary

Modifier and Type	Method and Description
Duration<IsoUnit>	build() Creates a new duration conforming to ISO-8601.
Duration.Builder	days(int num) Adds a day item.
Duration.Builder	hours(int num) Adds a hour item.
Duration.Builder	micros(int num) Adds a microsecond item.
Duration.Builder	millis(int num) Adds a millisecond item.
Duration.Builder	minutes(int num) Adds a minute item.
Duration.Builder	months(int num) Adds a month item.
Duration.Builder	nanos(int num) Adds a nanosecond item.
Duration.Builder	seconds(int num) Adds a second item.
Duration.Builder	years(int num) Adds a year item.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

years

public Duration.Builder years(int num)

Adds a year item.

Parameters:

num - count of years >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

See Also:

CalendarUnit.YEARS

months

public Duration.Builder months(int num)

Adds a month item.

Parameters:

num - count of months >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

See Also:

CalendarUnit.MONTHS

days

public Duration.Builder days(int num)

Adds a day item.

Parameters:

num - count of days >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

See Also:

CalendarUnit.DAYS

hours

public Duration.Builder hours(int num)

Adds a hour item.

Parameters:

num - count of hours >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

See Also:

ClockUnit.HOURS

minutes

public Duration.Builder minutes(int num)

Adds a minute item.

Parameters:

num - count of minutes >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

See Also:

ClockUnit.MINUTES

seconds

public Duration.Builder seconds(int num)

Adds a second item.

Parameters:

num - count of seconds >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

See Also:

ClockUnit.SECONDS

millis

public Duration.Builder millis(int num)

Adds a millisecond item.

The argument will automatically be normalized to nanoseconds.

Parameters:

num - count of milliseconds >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

micros

public Duration.Builder micros(int num)

Adds a microsecond item.

The argument will automatically be normalized to nanoseconds.

Parameters:

num - count of microseconds >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

nanos

public Duration.Builder nanos(int num)

Adds a nanosecond item.

Parameters:

num - count of nanoseconds >= 0

Returns:

this instance for method chaining

Throws:

java.lang.IllegalArgumentException - if the argument is negative

java.lang.IllegalStateException - if already called

See Also:

ClockUnit.NANOS

build

public Duration<IsoUnit> build()

Creates a new duration conforming to ISO-8601.

Returns:

new Duration