com.sportradar.unifiedodds.sdk.impl.entities.PlayerImpl Maven / Gradle / Ivy

/*
 * Copyright (C) Sportradar AG. See LICENSE for full license governing this code
 */

package com.sportradar.unifiedodds.sdk.impl.entities;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.sportradar.unifiedodds.sdk.entities.Player;
import com.sportradar.utils.URN;

import java.util.Locale;
import java.util.Map;

/**
 * Represents a player or driver in a sport event
 */
public class PlayerImpl implements Player {
    /**
     * The unique {@link URN} identifier representing the current {@link Player} instance
     */
    private final URN id;

    /**
     * An unmodifiable {@link Map} containing the available player name translations
     * @see com.google.common.collect.ImmutableMap
     */
    private final Map names;

    /**
     * Initializes a new instance of the {@link PlayerImpl} class
     *
     * @param id - the unique {@link URN} identifier representing the current {@link Player} instance
     * @param names - a {@link Map} containing the available player name translations
     */
    PlayerImpl(URN id, Map names) {
        Preconditions.checkNotNull(id);
        Preconditions.checkNotNull(names);

        this.id = id;
        this.names = ImmutableMap.copyOf(names);
    }

    /**
     * Returns the unique {@link URN} identifier representing the current {@link Player} instance
     *
     * @return - the unique {@link URN} identifier representing the current {@link Player} instance
     */
    @Override
    public URN getId() {
        return id;
    }

    /**
     * Returns an unmodifiable map of available translated names
     *
     * @return - an unmodifiable map of available translated names
     * @see com.google.common.collect.ImmutableMap
     */
    @Override
    public Map getNames() {
        return names;
    }

    /**
     * Returns the name of the player in the specified language
     *
     * @param locale - a {@link Locale} specifying the language of the returned name
     * @return - the name of the player in the specified language
     */
    @Override
    public String getName(Locale locale) {
        return names.get(locale);
    }

    /**
     * Returns a {@link String} describing the current {@link Player} instance
     *
     * @return - a {@link String} describing the current {@link Player} instance
     */
    @Override
    public String toString() {
        return "PlayerImpl{" +
                "id=" + id +
                ", names=" + names +
                '}';
    }
}