net.time4j.range

Class SingleUnitTimeSpan<U extends IsoDateUnit,D extends SingleUnitTimeSpan<U,D>>

java.lang.Object

net.time4j.range.SingleUnitTimeSpan<U,D>

Type Parameters:

U - generic type of calendrical units

All Implemented Interfaces:

Serializable, Comparable<D>, TimeSpan<U>

Direct Known Subclasses:

Months, Quarters, Weeks, Years

public abstract class SingleUnitTimeSpan<U extends IsoDateUnit,D extends SingleUnitTimeSpan<U,D>>
extends Object
implements TimeSpan<U>, Comparable<D>, Serializable

Represents a time span in one calendrical unit only.

Since:

3.21/4.17

Author:

Meno Hochschild

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface net.time4j.engine.TimeSpan

TimeSpan.Item<U>

Method Summary

Modifier and Type	Method and Description
D	abs() Yields a copy with the absolute amount.
<T extends TimePoint<? super U,T>> T	addTo(T time)
int	compareTo(D other)
boolean	contains(IsoDateUnit unit)
boolean	equals(Object obj)
int	getAmount() Yields the count of units as integer-based amount.
long	getPartialAmount(IsoDateUnit unit)
List<TimeSpan.Item<U>>	getTotalLength()
U	getUnit() Yields the associated unit.
int	hashCode()
D	inverse() Yields a copy with the negated amount.
boolean	isEmpty()
boolean	isNegative()
boolean	isPositive()
D	minus(D duration) Yields a copy with the subtracted duration.
D	minus(int amount) Yields a copy with the subtracted amount.
D	multipliedBy(int factor) Yields a copy with the multiplied amount.
D	plus(D duration) Yields a copy with the added duration.
D	plus(int amount) Yields a copy with the added amount.
<T extends TimePoint<? super U,T>> T	subtractFrom(T time)
Duration<U>	toStdDuration() Converts this instance to a general duration with the same amount and unit.
String	toString() Prints in ISO-8601-format "PnU" (n=amount, U=unit).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAmount

public int getAmount()

Yields the count of units as integer-based amount.

Returns:

int

getUnit

public U getUnit()

Yields the associated unit.

Returns:

calendrical unit

compareTo

public int compareTo(D other)

Specified by:

compareTo in interface Comparable<D extends SingleUnitTimeSpan<U,D>>

getTotalLength

public List<TimeSpan.Item<U>> getTotalLength()

Specified by:

getTotalLength in interface TimeSpan<U extends IsoDateUnit>

contains

public boolean contains(IsoDateUnit unit)

Specified by:

contains in interface TimeSpan<U extends IsoDateUnit>

getPartialAmount

public long getPartialAmount(IsoDateUnit unit)

Specified by:

getPartialAmount in interface TimeSpan<U extends IsoDateUnit>

isNegative

public boolean isNegative()

Specified by:

isNegative in interface TimeSpan<U extends IsoDateUnit>

isPositive

public boolean isPositive()

Specified by:

isPositive in interface TimeSpan<U extends IsoDateUnit>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface TimeSpan<U extends IsoDateUnit>

addTo

public <T extends TimePoint<? super U,T>> T addTo(T time)

Specified by:

addTo in interface TimeSpan<U extends IsoDateUnit>

subtractFrom

public <T extends TimePoint<? super U,T>> T subtractFrom(T time)

Specified by:

subtractFrom in interface TimeSpan<U extends IsoDateUnit>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Prints in ISO-8601-format "PnU" (n=amount, U=unit).

Negative durations will get a preceding sign before "P". Note that gregorian and week-based years have the same representation using the symbol Y.

Overrides:

toString in class Object

Returns:

the duration in ISO-8601-format

abs

public D abs()

Yields a copy with the absolute amount.

Returns:

immutable copy with the absolute amount

Throws:

ArithmeticException - if numeric overflow occurs (only in case of Integer.MIN_VALUE)

inverse

public D inverse()

Yields a copy with the negated amount.

Returns:

immutable copy with the reverse sign

Throws:

ArithmeticException - if numeric overflow occurs (only in case of Integer.MIN_VALUE)

plus

public D plus(int amount)

Yields a copy with the added amount.

Parameters:

amount - the amount to be added

Returns:

result of addition as immutable copy

Throws:

ArithmeticException - if numeric overflow occurs

plus

public D plus(D duration)

Yields a copy with the added duration.

Parameters:

duration - the duration to be added

Returns:

result of addition as immutable copy

Throws:

ArithmeticException - if numeric overflow occurs

minus

public D minus(int amount)

Yields a copy with the subtracted amount.

Parameters:

amount - the amount to be subtracted

Returns:

result of subtraction as immutable copy

Throws:

ArithmeticException - if numeric overflow occurs

minus

public D minus(D duration)

Yields a copy with the subtracted duration.

Parameters:

duration - the duration to be added

Returns:

result of subtraction as immutable copy

Throws:

ArithmeticException - if numeric overflow occurs

multipliedBy

public D multipliedBy(int factor)

Yields a copy with the multiplied amount.

Parameters:

factor - multiplication factor to be applied

Returns:

immutable copy with the multiplied amount

Throws:

ArithmeticException - if numeric overflow occurs

toStdDuration

public Duration<U> toStdDuration()

Converts this instance to a general duration with the same amount and unit.

Returns:

Duration