Package org.assertj.core.data

Class TemporalUnitOffset

java.lang.Object

org.assertj.core.data.TemporalUnitOffset

All Implemented Interfaces:

TemporalOffset<Temporal>

Direct Known Subclasses:

TemporalUnitLessThanOffset, TemporalUnitWithinOffset

public abstract class TemporalUnitOffset
extends Object
implements TemporalOffset<Temporal>

Base class for TemporalOffset on basis of TemporalUnit.

Since:

3.7.0

Field Summary

Fields

Modifier and Type	Field	Description
private TemporalUnit	unit
protected long	value

Constructor Summary

Constructors

Constructor	Description
TemporalUnitOffset(long value, TemporalUnit unit)	Creates a new temporal offset for a given temporal unit.

Method Summary

Modifier and Type	Method	Description
private void	checkThatValueIsPositive(long value)
String	getBeyondOffsetDifferenceDescription(Temporal temporal1, Temporal temporal2)	Returns description of the difference between temporal values and expected offset details.
protected long	getDifference(Temporal temporal1, Temporal temporal2)	Returns absolute value of the difference according to time unit.
TemporalUnit	getUnit()
long	getValue()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.assertj.core.data.TemporalOffset

isBeyondOffset

Field Detail

unit

private final TemporalUnit unit

value

protected final long value

Constructor Detail

TemporalUnitOffset

public TemporalUnitOffset(long value,
                          TemporalUnit unit)

Creates a new temporal offset for a given temporal unit.

Parameters:

value - the value of the offset.

unit - temporal unit of the offset.

Throws:

NullPointerException - if the given unit is null.

IllegalArgumentException - if the given value is negative.

Method Detail

checkThatValueIsPositive

private void checkThatValueIsPositive(long value)

getBeyondOffsetDifferenceDescription

public String getBeyondOffsetDifferenceDescription(Temporal temporal1,
                                                   Temporal temporal2)

Returns description of the difference between temporal values and expected offset details. Is designed for the case when difference is beyond offset.

Specified by:

getBeyondOffsetDifferenceDescription in interface TemporalOffset<Temporal>

Parameters:

temporal1 - first temporal value which is being validated against second temporal value.

temporal2 - second temporal value.

Returns:

difference description.

getDifference

protected long getDifference(Temporal temporal1,
                             Temporal temporal2)

Returns absolute value of the difference according to time unit.

Parameters:

temporal1 - the first Temporal

temporal2 - the second Temporal

Returns:

absolute value of the difference according to time unit.

getUnit

public TemporalUnit getUnit()

getValue

public long getValue()