001/*
002 * Copyright 2017-2022 Product Mog LLC, 2022-2025 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.lokalized;
018
019import javax.annotation.Nonnull;
020import java.util.List;
021import java.util.Locale;
022import java.util.Locale.LanguageRange;
023
024/**
025 * Contract for matching an input {@link Locale} or {@link List}{@code <}{@link LanguageRange}{@code >} to an appropriate localized strings {@link Locale}.
026 *
027 * @author <a href="https://revetkn.com">Mark Allen</a>
028 */
029public interface LocaleMatcher {
030        /**
031         * Given a language range, determine the best-matching localized strings file's locale.
032         *
033         * @param locale the locale for which to find the best match.
034         * @return the best-matching locale, not null
035         */
036        @Nonnull
037        Locale bestMatchFor(@Nonnull Locale locale);
038
039        /**
040         * Given a list of language ranges (e.g. as parsed from an {@code Accept-Language} HTTP request header), determine the best-matching localized strings file's locale.
041         *
042         * @param languageRanges the ordered list of language ranges for which to find the best match.
043         * @return the best-matching locale, not null
044         */
045        @Nonnull
046        Locale bestMatchFor(@Nonnull List<LanguageRange> languageRanges);
047}