Interface UnifiedMemberCacheView

    • Method Detail

      • getElementsById

        java.util.List<Member> getElementsById​(long id)
        Retrieves all member represented by the provided ID.
        Parameters:
        id - The ID of the members
        Returns:
        Possibly-empty unmodifiable list of member for the specified ID
      • getElementsById

        default java.util.List<Member> getElementsById​(java.lang.String id)
        Retrieves all member represented by the provided ID.
        Parameters:
        id - The ID of the members
        Returns:
        Possibly-empty unmodifiable list of member for the specified ID
        Throws:
        java.lang.NumberFormatException - If the provided String is null or cannot be resolved to an unsigned long id
      • getElementsByUsername

        java.util.List<Member> getElementsByUsername​(java.lang.String name,
                                                     boolean ignoreCase)
        Creates an immutable list of all members matching the given username.
        This will check the name of the wrapped user.
        Parameters:
        name - The name to check
        ignoreCase - Whether to ignore case when comparing usernames
        Returns:
        Immutable list of members with the given username
        Throws:
        java.lang.IllegalArgumentException - If the provided name is null
      • getElementsByUsername

        default java.util.List<Member> getElementsByUsername​(java.lang.String name)
        Creates an immutable list of all members matching the given username.
        This will check the name of the wrapped user.
        Parameters:
        name - The name to check
        Returns:
        Immutable list of members with the given username
        Throws:
        java.lang.IllegalArgumentException - If the provided name is null
      • getElementsByNickname

        java.util.List<Member> getElementsByNickname​(@Nullable
                                                     java.lang.String name,
                                                     boolean ignoreCase)
        Creates an immutable list of all members matching the given nickname.
        This will check the nickname of the member. If provided with null this will check for members that have no nickname set.
        Parameters:
        name - The nullable nickname to check
        ignoreCase - Whether to ignore case when comparing nicknames
        Returns:
        Immutable list of members with the given nickname
      • getElementsByNickname

        default java.util.List<Member> getElementsByNickname​(@Nullable
                                                             java.lang.String name)
        Creates an immutable list of all members matching the given nickname.
        This will check the nickname of the member. If provided with null this will check for members that have no nickname set.
        Parameters:
        name - The nullable nickname to check
        Returns:
        Immutable list of members with the given nickname
      • getElementsWithRoles

        java.util.List<Member> getElementsWithRoles​(Role... roles)
        Creates an immutable list of all members that hold all of the provided roles.
        Parameters:
        roles - Roles the members should have
        Returns:
        Immutable list of members with the given roles
        Throws:
        java.lang.IllegalArgumentException - If provided with null
      • getElementsWithRoles

        java.util.List<Member> getElementsWithRoles​(java.util.Collection<Role> roles)
        Creates an immutable list of all members that hold all of the provided roles.
        Parameters:
        roles - Roles the members should have
        Returns:
        Immutable list of members with the given roles
        Throws:
        java.lang.IllegalArgumentException - If provided with null