Module org.refcodes.checkerboard
Package org.refcodes.checkerboard

Interface Players<P extends Player<P,?>>

Type Parameters:
P - the generic type
All Known Subinterfaces:
Checkerboard<P,S>
All Known Implementing Classes:
AbstractCheckerboard
public interface Players<P extends Player<P,?>>
The Interface Players.
Author:
steiner

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearPlayers()
    Clear players.
    default <PLAYER extends P>
    PLAYER
    firstPlayer(Class<PLAYER> aType)
    Returns the first player found being of the given type.
    List<P>
    getPlayers()
    Gets the players.
    boolean
    hasPlayer(P aElement)
    Checks for player.
    boolean
    hasPlayers()
    Checks for players.
    int
    playerCount()
    Player count.
    Iterator<P>
    players()
    Players.
    default <PLAYER extends P>
    PLAYER[]
    players(Class<PLAYER> aType)
    Returns an array containing all the players being of the given type.
    P
    putPlayer(P aElement)
    Put player.
    boolean
    removePlayer(P aElement)
    Removes the player.

  • Method Details

    • getPlayers

      List<P> getPlayers()
      Gets the players.
      Returns:
      the players

    • players

      Iterator<P> players()
      Players.
      Returns:
      the iterator

    • hasPlayer

      boolean hasPlayer(P aElement)
      Checks for player.
      Parameters:
      aElement - the element
      Returns:
      true, if successful

    • playerCount

      int playerCount()
      Player count.
      Returns:
      the int

    • hasPlayers

      boolean hasPlayers()
      Checks for players.
      Returns:
      true, if successful

    • clearPlayers

      void clearPlayers()
      Clear players.

    • putPlayer

      P putPlayer(P aElement)
      Put player.
      Parameters:
      aElement - the element
      Returns:
      the p

    • removePlayer

      boolean removePlayer(P aElement)
      Removes the player.
      Parameters:
      aElement - the element
      Returns:
      true, if successful

    • players

      default <PLAYER extends P> PLAYER[] players(Class<PLAYER> aType)
      Returns an array containing all the players being of the given type.
      Type Parameters:
      PLAYER - The type of the player to seek for.
      Parameters:
      aType - The type of the player to find.
      Returns:
      The according array, if no players were found then the array is empty.

    • firstPlayer

      default <PLAYER extends P> PLAYER firstPlayer(Class<PLAYER> aType)
      Returns the first player found being of the given type.
      Type Parameters:
      PLAYER - The type of the player to seek for.
      Parameters:
      aType - The type of the player to find.
      Returns:
      The according player or null if no players were found matching the given type.