com.screenscraper.util.suppliers

Class NumberSupplier

java.lang.Object

com.screenscraper.util.suppliers.NumberSupplier

All Implemented Interfaces:

ResettableSupplier<java.lang.Long>, java.util.function.Supplier<java.lang.Long>

public class NumberSupplier
extends java.lang.Object
implements ResettableSupplier<java.lang.Long>

Supplier of numbers. Will return numbers from a starting to ending value using an increment specified. Once the end number is exceeded this will return null. This class is not thread safe

Version:

7.0.12a

Constructor Summary

Constructors

Constructor and Description
NumberSupplier(long startNumber, long endNumber) Creates the number supplier.
NumberSupplier(long startNumber, long endNumber, long incrementBy) Creates the number supplier.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Long	get()
int	hashCode()
void	reset() Resets the state of this supplier so that the next call to get() returns as if it were the first time the method were called
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NumberSupplier

public NumberSupplier(long startNumber,
                      long endNumber)

Creates the number supplier. This increments by 1 each time from start to end (or if end is smaller than start it swaps them first)

Parameters:

startNumber - The starting number to return (inclusive)

endNumber - The ending number to return (inclusive)

NumberSupplier

public NumberSupplier(long startNumber,
                      long endNumber,
                      long incrementBy)

Creates the number supplier. Note starting and ending numbers may be swapped if the incrementBy amount makes the swap go in the wrong direction (won't use overflow to wrap around)

Parameters:

startNumber - The starting number to return (inclusive)

endNumber - The ending number to return (inclusive)

incrementBy - How much to increment each time

Method Detail

reset

public void reset()

Description copied from interface: ResettableSupplier

Resets the state of this supplier so that the next call to get() returns as if it were the first time the method were called

Specified by:

reset in interface ResettableSupplier<java.lang.Long>

get

@Nullable
public java.lang.Long get()

Specified by:

get in interface java.util.function.Supplier<java.lang.Long>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object