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 javax.annotation.concurrent.ThreadSafe;
022import java.util.Locale;
023
024/**
025 * Resolves {@link Phonetic} categories for terms at runtime.
026 * <p>
027 * This allows callers to supply language-specific phonetic logic without
028 * Lokalized needing a built-in phonetic dictionary.
029 * Implementations shared by a {@link Strings} instance may be invoked concurrently and must be thread-safe.
030 *
031 * @author <a href="https://revetkn.com">Mark Allen</a>
032 * @since 1.2.0
033 */
034@ThreadSafe
035@FunctionalInterface
036public interface PhoneticResolver {
037  /**
038   * Determines the phonetic category for a term.
039   *
040   * @param term the term to classify, not null
041   * @param locale the locale in which to resolve the term, not null
042   * @return the phonetic category for the term, not null
043   */
044  @NonNull
045  Phonetic resolve(@NonNull String term, @NonNull Locale locale);
046}