Package com.xpdustry.distributor.api.player

Interface PlayerLookup

public interface PlayerLookup

A simple interface for looking up online players.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PlayerLookup.Field	The fields to take into account when searching.
static interface	PlayerLookup.Query	A query for looking up players.

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<String,String>	DEFAULT_NORMALIZER
static final Supplier<Collection<mindustry.gen.Player>>	DEFAULT_PROVIDER

Method Summary

Modifier and Type	Method	Description
static PlayerLookup	create()	Creates a new player lookup with the default provider and normalizer.
static PlayerLookup	create(Supplier<Collection<mindustry.gen.Player>> provider, Function<String,String> normalizer)	Creates a new player lookup with the given provider and normalizer.
List<mindustry.gen.Player>	findOnlinePlayers(PlayerLookup.Query query)	Finds online players matching the given query.

Field Details

DEFAULT_PROVIDER

static final Supplier<Collection<mindustry.gen.Player>> DEFAULT_PROVIDER

DEFAULT_NORMALIZER

static final Function<String,String> DEFAULT_NORMALIZER

Method Details

create

static PlayerLookup create()

Creates a new player lookup with the default provider and normalizer.

create

static PlayerLookup create(Supplier<Collection<mindustry.gen.Player>> provider,
 Function<String,String> normalizer)

Creates a new player lookup with the given provider and normalizer.

Parameters:

provider - the player provider

normalizer - the normalizer

Returns:

the player lookup

findOnlinePlayers

List<mindustry.gen.Player> findOnlinePlayers(PlayerLookup.Query query)

Finds online players matching the given query.

Parameters:

query - the query

Returns:

the matching players