Top Description Fields Constructors Methods
org.assertj.core.data

public abstract Class TemporalUnitOffset

extends Object
implements TemporalOffset<Temporal>
Class Inheritance
All Implemented Interfaces
org.assertj.core.data.TemporalOffset
Known Direct Subclasses
org.assertj.core.data.TemporalUnitWithinOffset, org.assertj.core.data.TemporalUnitLessThanOffset
Static Imports
java.lang.Math.abs, .String.format, java.util.Objects.requireNonNull, org.assertj.core.util.Preconditions.checkArgument

Base class for TemporalOffset on basis of TemporalUnit.
Since
3.7.0

Field Summary

Modifier and TypeField and Description
protected final TemporalUnit
protected final long

Constructor Summary

AccessConstructor and Description
public
TemporalUnitOffset(long
the value of the offset.
value
,
TemporalUnit
temporal unit of the offset.
unit
)

Creates a new temporal offset for a given temporal unit.

Method Summary

Modifier and TypeMethod and Description
private static void
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
protected Duration

Returns:

absolute value of the difference as Duration.
getAbsoluteDuration
(Temporal
the first Temporal
temporal1
,
Temporal
the second Temporal
temporal2
)

Returns absolute value of the difference as Duration.

public String
getBeyondOffsetDifferenceDescription(Temporal
first temporal value which is being validated against second temporal value.
temporal1
,
Temporal
second temporal value.
temporal2
)

Implements org.assertj.core.data.TemporalOffset.getBeyondOffsetDifferenceDescription.

Returns description of the difference between temporal values and expected offset details.
protected long

Returns:

absolute value of the difference according to time unit.
getDifference
(Temporal
the first Temporal
temporal1
,
Temporal
the second Temporal
temporal2
)

Returns absolute value of the difference according to time unit.

public TemporalUnit
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

unitback to summary
protected final TemporalUnit unit
valueback to summary
protected final long value

Constructor Detail

TemporalUnitOffsetback to summary
public TemporalUnitOffset(long value, TemporalUnit unit)

Creates a new temporal offset for a given temporal unit.

Parameters
value:long

the value of the offset.

unit:TemporalUnit

temporal unit of the offset.

Exceptions
NullPointerException:
if the given unit is null.
IllegalArgumentException:
if the given value is negative.

Method Detail

checkThatValueIsPositiveback to summary
private static void checkThatValueIsPositive(long value)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAbsoluteDurationback to summary
protected Duration getAbsoluteDuration(Temporal temporal1, Temporal temporal2)

Returns absolute value of the difference as Duration.

Parameters
temporal1:Temporal

the first Temporal

temporal2:Temporal

the second Temporal

Returns:Duration

absolute value of the difference as Duration.

getBeyondOffsetDifferenceDescriptionback to summary
public String getBeyondOffsetDifferenceDescription(Temporal temporal1, Temporal temporal2)

Implements org.assertj.core.data.TemporalOffset.getBeyondOffsetDifferenceDescription.

Doc from org.assertj.core.data.TemporalOffset.getBeyondOffsetDifferenceDescription.

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

Parameters
temporal1:Temporal

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

temporal2:Temporal

second temporal value.

Returns:String

difference description.

Annotations
@Override
getDifferenceback to summary
protected long getDifference(Temporal temporal1, Temporal temporal2)

Returns absolute value of the difference according to time unit.

Parameters
temporal1:Temporal

the first Temporal

temporal2:Temporal

the second Temporal

Returns:long

absolute value of the difference according to time unit.

getUnitback to summary
public TemporalUnit getUnit()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override