com.exaroton.api.server.PlayerList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
The official exaroton java library
There is a newer version: 1.5.0
package com.exaroton.api.server;

import com.exaroton.api.APIException;
import com.exaroton.api.ExarotonClient;
import com.exaroton.api.request.server.AddPlayerListEntriesRequest;
import com.exaroton.api.request.server.GetPlayerListEntriesRequest;
import com.exaroton.api.request.server.RemovePlayerListEntriesRequest;

public class PlayerList {
    private final String name;
    private final String server;
    private final ExarotonClient client;

    /**
     * create a new playerlist
     * @param name playerlist name (see Server.getPlayerLists)
     * @param server exaroton server
     * @param client exaroton client
     */
    public PlayerList(String name, String server, ExarotonClient client) {
        if (name == null) throw new IllegalArgumentException("List name can't be null");
        this.name = name;
        this.server = server;
        this.client = client;
    }

    /**
     * @return list name
     */
    public String getName() {
        return name;
    }

    /**
     * @return players in list
     * @throws APIException API error
     */
    public String[] getEntries() throws APIException {
        GetPlayerListEntriesRequest request = new GetPlayerListEntriesRequest(this.client, this.server, this.name);
        return request.request().getData();
    }

    /**
     * add players to list
     * @param entries player names
     * @throws APIException API error
     */
    public void add(String[] entries) throws APIException {
        AddPlayerListEntriesRequest request = new AddPlayerListEntriesRequest(this.client, this.server, this.name, entries);
        request.request();
    }

    /**
     * add player to list
     * @param entry player name
     * @throws APIException API error
     */
    public void add(String entry) throws APIException {
        this.add(new String[]{entry});
    }

    /**
     * remove players from list
     * @param entries player names
     * @throws APIException API error
     */
    public void remove(String[] entries) throws APIException {
        RemovePlayerListEntriesRequest request = new RemovePlayerListEntriesRequest(this.client, this.server, this.name, entries);
        request.request();
    }

    /**
     * remove player from list
     * @param entry player name
     * @throws APIException API error
     */
    public void remove(String entry) throws APIException {
        this.remove(new String[]{entry});
    }

}