org.dc.riot.lol.rx.model.league.LeagueDto Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lol-api-rxjava Show documentation

Service library for League of Legends API

There is a newer version: 1.0.5

package org.dc.riot.lol.rx.model.league;

import org.dc.riot.lol.rx.model.common.QueueType;
import org.dc.riot.lol.rx.model.common.Tier;

/**
 * This object contains league information.
 * 
 * @author Dc
 * @since 1.0.0
 */
public class LeagueDto {
	private static long COUNT = 0;
	public static long getInstanceCount() {
		return COUNT;
	}

    private String name;
    private LeagueEntryDto[] entries;
    private QueueType queue;
    private Tier tier;
    private String participantId;
    
    public LeagueDto() {
    	COUNT++;
    }

    /**
     * @return This name is an internal place-holder name only. Display and
     * localization of names in the game client are handled client-side.
     */
    public String getName() {
        return name;
    }

    /**
     * @return The requested league entries or
     * empty if not defined.
     */
    public LeagueEntryDto[] getEntries() {
    	if (entries == null) {
    		return new LeagueEntryDto[0];
    	}

        return entries;
    }

    /**
     * @return The league's queue type.
     * (Legal values: RANKED_SOLO_5x5, RANKED_TEAM_3x3, RANKED_TEAM_5x5)
     */
    public QueueType getQueue() {
        return queue;
    }

    /**
     * @return 	The league's tier. (Legal values:
     * CHALLENGER, MASTER, DIAMOND, PLATINUM, GOLD, SILVER, BRONZE)
     */
    public Tier getTier() {
        return tier;
    }

    /**
     * Specifies the relevant participant that is a member of this
     * league (i.e., a requested summoner ID, a requested team ID,
     * or the ID of a team to which one of the requested summoners belongs).
     * Only present when full league is requested so that participant's entry
     * can be identified. Not present when individual entry is requested.
     *
     * @return Some kind of relevant ID based on context or null.
     */
    public String getParticipantId() {
        return participantId;
    }
}