Package dev.getelements.elements.sdk.dao

Interface MultiMatchDao

All Known Implementing Classes:

MongoMultiMatchDao

public interface MultiMatchDao

Handles multi-matches, allowing multiple players to join or leave a match.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MULTI_MATCH_ADD_PROFILE
static final String	MULTI_MATCH_CREATED
static final String	MULTI_MATCH_DELETED
static final String	MULTI_MATCH_EXPIRED
static final String	MULTI_MATCH_REMOVE_PROFILE
static final String	MULTI_MATCH_UPDATED
static final String	MULTI_MATCHES_TRUNCATED

Method Summary

Modifier and Type	Method	Description
MultiMatch	addProfile(String multiMatchId, Profile profile)	Adds a new Profile to the MultiMatch.
MultiMatch	closeMatch(String multiMatchId)	Flags the MultiMatch as closed, disallowing players to join.
MultiMatch	createMultiMatch(MultiMatch multiMatch)	Creates a new MultiMatch with no players.
MultiMatch	createMultiMatch(MultiMatch multiMatch, UniqueCodeDao.GenerationParameters joinCodeGenerationParameters)	Creates a new MultiMatch with no players.
void	deleteAllMultiMatches()	Deletes all of the MultiMatch instances.
default void	deleteMultiMatch(String multiMatchId)	Deletes the MultiMatch with the given ID, throwing an exception if it does not exist.
MultiMatch	endMatch(String multiMatchId)	Flags the MultiMatch as ended, disallowing players to join.
Optional<MultiMatch>	findMultiMatch(String multiMatchId)	Finds a MultiMatch by its ID.
Optional<MultiMatch>	findMultiMatchByJoinCode(String joinCode)	Finds a MultiMatch by its ID.
Optional<MultiMatch>	findOldestAvailableMultiMatchCandidate(MatchmakingApplicationConfiguration configuration, String profileId, String query)	Finds the latest MultiMatch for the given configuration and profile ID.
default List<MultiMatch>	getAllMultiMatches()	Gets all MultiMatch instances.
List<MultiMatch>	getAllMultiMatches(String query)	Gets all MultiMatch instances.
default MultiMatch	getMultiMatch(String multiMatchId)	Gets a MultiMatch by its ID.
default MultiMatch	getMultiMatchByJoinCode(String joinCode)	Gets a MultiMatch by its ID.
default Pagination<MultiMatch>	getMultiMatches(int offset, int count)	Fetches a paginated subset of MultiMatch instances.
Pagination<MultiMatch>	getMultiMatches(int offset, int count, String search)	Fetches a paginated subset of MultiMatch instances matching the search.
List<Profile>	getProfiles(String multiMatchId)	Gets all Profile instances in the MultiMatch.
MultiMatch	openMatch(String multiMatchId)	Flags the MultiMatch as open, allowing players to join.
MultiMatch	refreshMatch(String multiMatchId)	Refreshes the MultiMatch, resetting its expiry timer.
MultiMatch	removeProfile(String multiMatchId, Profile profile)	Removes the Profile to the MultiMatch.
boolean	tryDeleteMultiMatch(String multiMatchId)	Deletes the MultiMatch with the given ID, returning true if it was deleted, false if it did not exist.
MultiMatch	updateMultiMatch(String matchId, MultiMatch configuration)	Creates a new MultiMatch with no players.

Field Details

MULTI_MATCH_CREATED

static final String MULTI_MATCH_CREATED

See Also:

• Constant Field Values

MULTI_MATCH_ADD_PROFILE

static final String MULTI_MATCH_ADD_PROFILE

See Also:

• Constant Field Values

MULTI_MATCH_REMOVE_PROFILE

static final String MULTI_MATCH_REMOVE_PROFILE

See Also:

• Constant Field Values

MULTI_MATCH_UPDATED

static final String MULTI_MATCH_UPDATED

See Also:

• Constant Field Values

MULTI_MATCH_EXPIRED

static final String MULTI_MATCH_EXPIRED

See Also:

• Constant Field Values

MULTI_MATCH_DELETED

static final String MULTI_MATCH_DELETED

See Also:

• Constant Field Values

MULTI_MATCHES_TRUNCATED

static final String MULTI_MATCHES_TRUNCATED

See Also:

• Constant Field Values

Method Details

getAllMultiMatches

default List<MultiMatch> getAllMultiMatches()

Gets all MultiMatch instances.

Returns:

a List of MultiMatch instances

getAllMultiMatches

List<MultiMatch> getAllMultiMatches(String query)

Gets all MultiMatch instances.

Parameters:

query - the query to execute

Returns:

a List of MultiMatch instances

getMultiMatches

Pagination<MultiMatch> getMultiMatches(int offset,
 int count,
 String search)

Fetches a paginated subset of MultiMatch instances matching the search.

Parameters:

offset - - Pagination offset

count - - Maximum objects in results

search - - Search query to filter results

Returns:

Pagination of MultiMatch

getMultiMatches

default Pagination<MultiMatch> getMultiMatches(int offset,
 int count)

Fetches a paginated subset of MultiMatch instances.

Parameters:

offset - - Pagination offset

count - - Maximum objects in results

Returns:

Pagination of MultiMatch

findMultiMatch

Optional<MultiMatch> findMultiMatch(String multiMatchId)

Finds a MultiMatch by its ID.

Parameters:

multiMatchId - the ID of the multi-match to find.

Returns:

the found MultiMatch, or an empty Optional if not found.

findMultiMatchByJoinCode

Optional<MultiMatch> findMultiMatchByJoinCode(String joinCode)

Finds a MultiMatch by its ID.

Parameters:

joinCode - the join code of the multi match.

Returns:

the found MultiMatch, or an empty Optional if not found.

findOldestAvailableMultiMatchCandidate

Optional<MultiMatch> findOldestAvailableMultiMatchCandidate(MatchmakingApplicationConfiguration configuration,
 String profileId,
 String query)

Finds the latest MultiMatch for the given configuration and profile ID. This method will exclude any matches that the specific profile currently not participating in. If no match meets the criteria, then an empty optional is returned allowing downstream code to create a new match. Additionally, a query can be provided to further filter the matches that are considered. The query is appended to the supplied criteria.

Parameters:

configuration - the matchmaking configuration

profileId - the profile ID to find the latest match for

query - the query to execute when searching for a match

Returns:

the found MultiMatch, or an empty Optional if not found.

getMultiMatch

default MultiMatch getMultiMatch(String multiMatchId)

Gets a MultiMatch by its ID.

Parameters:

multiMatchId - the MultiMatch's id

Returns:

the MultiMatch

getMultiMatchByJoinCode

default MultiMatch getMultiMatchByJoinCode(String joinCode)

Gets a MultiMatch by its ID.

Parameters:

joinCode - the MultiMatch's join code

Returns:

the MultiMatch

getProfiles

List<Profile> getProfiles(String multiMatchId)

Gets all Profile instances in the MultiMatch.

Parameters:

multiMatchId - tbe multi-match id to get profiles from

Returns:

the List of Profile instances in the MultiMatch

Throws:

MultiMatchNotFoundException - if no MultiMatch with the given ID exists

addProfile

MultiMatch addProfile(String multiMatchId,
 Profile profile)

Adds a new Profile to the MultiMatch. Automatically sets the match status to MultiMatchStatus.FULL if the match reaches capacity.

Parameters:

multiMatchId - the multi-match id receiving the profile

profile - the profile to add

Returns:

the updated MultiMatch

removeProfile

MultiMatch removeProfile(String multiMatchId,
 Profile profile)

Removes the Profile to the MultiMatch. Automatically sets the match status to MultiMatchStatus.OPEN if the match was previously full and not MultiMatchStatus.CLOSED.

Parameters:

multiMatchId - the multi-match id receiving the profile

profile - the profile to add

Returns:

the updated MultiMatch

createMultiMatch

MultiMatch createMultiMatch(MultiMatch multiMatch)

Creates a new MultiMatch with no players.

Parameters:

multiMatch - the MultiMatch to create

Returns:

the newly created MultiMatch

createMultiMatch

MultiMatch createMultiMatch(MultiMatch multiMatch,
 UniqueCodeDao.GenerationParameters joinCodeGenerationParameters)

Creates a new MultiMatch with no players.

Parameters:

multiMatch - the MultiMatch to create

joinCodeGenerationParameters - the UniqueCodeDao.GenerationParameters to use when generating the join code

Returns:

the newly created MultiMatch

updateMultiMatch

MultiMatch updateMultiMatch(String matchId,
 MultiMatch configuration)

Creates a new MultiMatch with no players.

Parameters:

configuration - the MatchmakingApplicationConfiguration to use

Returns:

the newly created MultiMatch

openMatch

MultiMatch openMatch(String multiMatchId)

Flags the MultiMatch as open, allowing players to join. If the match is currently full, then this operation will set the match as MultiMatchStatus.FULL, otherwise it will set the match to MultiMatchStatus.OPEN.

Parameters:

multiMatchId - the MultiMatch

Returns:

the updated MultiMatch

closeMatch

MultiMatch closeMatch(String multiMatchId)

Flags the MultiMatch as closed, disallowing players to join. This operation will set the match as MultiMatchStatus.CLOSED. Fails if the match is MultiMatchStatus.ENDED.

Parameters:

multiMatchId - the multi-match id to refresh

Returns:

the updated MultiMatch

endMatch

MultiMatch endMatch(String multiMatchId)

Flags the MultiMatch as ended, disallowing players to join. This operation will set the match as MultiMatchStatus.ENDED. Fails if the match is already MultiMatchStatus.ENDED.

Parameters:

multiMatchId - the multi-match id to refresh

Returns:

the updated MultiMatch

refreshMatch

MultiMatch refreshMatch(String multiMatchId)

Refreshes the MultiMatch, resetting its expiry timer.

Parameters:

multiMatchId - the multi-match id to refresh

Returns:

the updated MultiMatch

deleteAllMultiMatches

void deleteAllMultiMatches()

Deletes all of the MultiMatch instances.

deleteMultiMatch

default void deleteMultiMatch(String multiMatchId)

Deletes the MultiMatch with the given ID, throwing an exception if it does not exist.

tryDeleteMultiMatch

boolean tryDeleteMultiMatch(String multiMatchId)

Deletes the MultiMatch with the given ID, returning true if it was deleted, false if it did not exist.