001/*
002 * Copyright 2017-2022 Product Mog LLC, 2022-2026 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 org.jspecify.annotations.NonNull;
020
021import java.util.List;
022import java.util.Locale;
023import java.util.Locale.LanguageRange;
024
025/**
026 * Contract for matching an input {@link Locale} or {@link List}{@code <}{@link LanguageRange}{@code >} to an appropriate localized strings {@link Locale}.
027 *
028 * @author <a href="https://revetkn.com">Mark Allen</a>
029 */
030public interface LocaleMatcher {
031        /**
032         * Given a language range, determine the best-matching localized strings file's locale.
033         *
034         * @param locale the locale for which to find the best match.
035         * @return the best-matching locale, not null
036         */
037        @NonNull
038        Locale bestMatchFor(@NonNull Locale locale);
039
040        /**
041         * 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.
042         *
043         * @param languageRanges the ordered list of language ranges for which to find the best match.
044         * @return the best-matching locale, not null
045         */
046        @NonNull
047        Locale bestMatchFor(@NonNull List<@NonNull LanguageRange> languageRanges);
048}