Class LongMax
- All Implemented Interfaces:
DoubleSupplier
,IntSupplier
,LongConsumer
,LongSupplier
,LongStatistic
,StatisticAccumulator<LongMax>
,StatisticResult
Math.max
as an
underlying function to compute the maximum
.
- The result is
Long.MIN_VALUE
if no values are added.
This class is designed to work with (though does not require) streams.
This implementation is not thread safe.
If multiple threads access an instance of this class concurrently,
and at least one of the threads invokes the accept
or
combine
method, it must be synchronized externally.
However, it is safe to use accept
and combine
as accumulator
and combiner
functions of
Collector
on a parallel stream,
because the parallel implementation of Stream.collect()
provides the necessary partitioning, isolation, and merging of results for
safe and efficient parallel execution.
- Since:
- 1.1
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(long value) Updates the state of the statistic to reflect the addition ofvalue
.Combines the state of theother
statistic into this one.static LongMax
create()
Creates an instance.Gets a result as aBigInteger
.double
int
getAsInt()
Gets the maximum of all input values.long
Gets the maximum of all input values.static LongMax
of
(long... values) Returns an instance populated using the inputvalues
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.function.LongConsumer
andThen
-
Field Details
-
maximum
private long maximumCurrent maximum.
-
-
Constructor Details
-
LongMax
private LongMax()Create an instance.
-
-
Method Details
-
create
Creates an instance.The initial result is
Long.MIN_VALUE
.- Returns:
Min
instance.
-
of
Returns an instance populated using the inputvalues
.When the input is an empty array, the result is
Long.MIN_VALUE
.- Parameters:
values
- Values.- Returns:
Min
instance.
-
accept
public void accept(long value) Updates the state of the statistic to reflect the addition ofvalue
.- Specified by:
accept
in interfaceLongConsumer
- Parameters:
value
- Value.
-
getAsLong
public long getAsLong()Gets the maximum of all input values.When no values have been added, the result is
Long.MIN_VALUE
.- Specified by:
getAsLong
in interfaceLongSupplier
- Specified by:
getAsLong
in interfaceStatisticResult
- Returns:
- maximum of all values.
-
getAsInt
public int getAsInt()Gets the maximum of all input values.This method will throw an
ArithmeticException
if thelong
maximum overflows anint
; or no values have been added.- Specified by:
getAsInt
in interfaceIntSupplier
- Specified by:
getAsInt
in interfaceStatisticResult
- Returns:
- maximum of all values.
- See Also:
-
getAsDouble
public double getAsDouble()- Specified by:
getAsDouble
in interfaceDoubleSupplier
-
getAsBigInteger
Description copied from interface:StatisticResult
Gets a result as aBigInteger
.The default implementation uses the closest representable
BigInteger
value of theDoubleSupplier.getAsDouble()
result
. In the event of ties the result is rounded towards positive infinity. This will raise anArithmeticException
if theresult
is not finite.- Specified by:
getAsBigInteger
in interfaceStatisticResult
- Returns:
- a result
-
combine
Description copied from interface:StatisticAccumulator
Combines the state of theother
statistic into this one.- Specified by:
combine
in interfaceStatisticAccumulator<LongMax>
- Parameters:
other
- Another statistic to be combined.- Returns:
this
instance after combiningother
.
-