Package com.ohacd.matchbox.api

Class ApiValidationHelper

java.lang.Object
com.ohacd.matchbox.api.ApiValidationHelper
public final class ApiValidationHelper extends Object
Utility class for validating common API inputs and providing helpful error messages.

This class contains static methods to validate common configurations and provide detailed feedback about what went wrong during validation failures.

Since:
0.9.5

  • Method Details

    • validatePlayers

      @NotNull public static @NotNull ApiValidationHelper.ValidationResult validatePlayers(@Nullable @Nullable Collection<org.bukkit.entity.Player> players)
      Validates a collection of players for session creation.
      Parameters:
      players - the players to validate
      Returns:
      ValidationResult containing validation outcome

    • validateSpawnPoints

      @NotNull public static @NotNull ApiValidationHelper.ValidationResult validateSpawnPoints(@Nullable @Nullable Collection<org.bukkit.Location> spawnPoints)
      Validates a collection of spawn locations for session creation.
      Parameters:
      spawnPoints - the spawn locations to validate
      Returns:
      ValidationResult containing validation outcome

    • validateDiscussionLocation

      @NotNull public static @NotNull ApiValidationHelper.ValidationResult validateDiscussionLocation(@Nullable @Nullable org.bukkit.Location discussionLocation)
      Validates a discussion location for session creation.
      Parameters:
      discussionLocation - the discussion location to validate
      Returns:
      ValidationResult containing validation outcome

    • validateSeatLocations

      @NotNull public static @NotNull ApiValidationHelper.ValidationResult validateSeatLocations(@Nullable @Nullable Map<Integer,org.bukkit.Location> seatLocations)
      Validates seat locations for session creation.
      Parameters:
      seatLocations - the seat locations to validate
      Returns:
      ValidationResult containing validation outcome

    • validateSessionName

      @NotNull public static @NotNull ApiValidationHelper.ValidationResult validateSessionName(@Nullable @Nullable String sessionName)
      Validates a session name.
      Parameters:
      sessionName - the session name to validate
      Returns:
      ValidationResult containing validation outcome

    • validatePlayerCount

      @NotNull public static @NotNull ApiValidationHelper.ValidationResult validatePlayerCount(int playerCount)
      Validates that the number of players is sufficient for a game.
      Parameters:
      playerCount - the number of players
      Returns:
      ValidationResult containing validation outcome

    • validateSpawnCount

      @NotNull public static @NotNull ApiValidationHelper.ValidationResult validateSpawnCount(int spawnCount, int playerCount)
      Validates that the number of spawn points is sufficient for players.
      Parameters:
      spawnCount - the number of spawn points
      playerCount - the number of players
      Returns:
      ValidationResult containing validation outcome

    • getValidationSummary

      @NotNull public static @NotNull String getValidationSummary(@NotNull @NotNull ApiValidationHelper.ValidationResult... results)
      Gets a summary of validation results.
      Parameters:
      results - the validation results to summarize
      Returns:
      a human-readable summary