/*
 * This file is part of LanternServer, licensed under the MIT License (MIT).
 *
 * Copyright (c) LanternPowered <https://www.lanternpowered.org>
 * Copyright (c) SpongePowered <https://www.spongepowered.org>
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the Software), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.lanternpowered.server.text.translation;

import org.lanternpowered.api.asset.Asset;
import org.spongepowered.api.text.translation.Translation;

import java.util.Locale;
import java.util.Optional;
import java.util.ResourceBundle;

public interface TranslationManager {

    /**
     * Adds a resource bundle to the translation manager.
     *
     * @param asset The resource bundle asset to add
     * @param locale The locale of the resource bundle
     */
    void addResourceBundle(Asset asset, Locale locale);

    /**
     * Gets a {@link Translation} for the specified key.
     * 
     * @param key the key
     * @return the translation
     */
    Translation get(String key);

    /**
     * Gets a {@link Translation} if the key is present in one
     * of the {@link ResourceBundle}s.
     * 
     * @param key the key
     * @return the translation
     */
    Optional<Translation> getIfPresent(String key);

}