com.screenscraper.util.suppliers

Class CharacterSupplier

java.lang.Object

com.screenscraper.util.suppliers.CharacterSupplier

All Implemented Interfaces:

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

public class CharacterSupplier
extends java.lang.Object
implements ResettableSupplier<java.lang.String>

Supplier to supply strings of characters. Returned strings will be [start, start, start, start + n] and will update the final character each time until the end character is reached, then the n - 1th character will increment and the nth character will reset until the first character in the string rolls past the update character, at which point this will return null. This class in not thread safe

Version:

7.0.12a

Constructor Summary

Constructors

Constructor and Description
CharacterSupplier(char start, char end) Creates a new Character Supplier that returns strings of length 1
CharacterSupplier(char start, char end, int returnLength) Creates a new Character Supplier

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	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

CharacterSupplier

public CharacterSupplier(char start,
                         char end)

Creates a new Character Supplier that returns strings of length 1

Parameters:

start - The first character to use (inclusive)

end - The last character to use (inclusive)

CharacterSupplier

public CharacterSupplier(char start,
                         char end,
                         int returnLength)

Creates a new Character Supplier

Parameters:

start - The first character to use (inclusive)

end - The last character to use (inclusive)

returnLength - How many characters to return in each string

Method Detail

reset

public final 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.String>

get

@Nullable
public java.lang.String get()

Specified by:

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

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