com.adobe.cq.smartcontent.LanguageData Maven / Gradle / Ivy

/*
 * ADOBE CONFIDENTIAL
 *
 * Copyright 2016 Adobe Systems Incorporated
 * All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and may be covered by U.S. and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 */

package com.adobe.cq.smartcontent;

import aQute.bnd.annotation.ProviderType;

import java.util.Locale;

/**
 * This interface represents implementation-specific language data.
 *
 * Typically, it contains references to dictionaries, language models, etc.
 */
@ProviderType
public interface LanguageData {

    /**
     * Get the locale of the language data.
     *
     * Note that the returned locale represents the actual locale of the data, which
     * may be different to the one specified for
     * {@link SmartContentAuthoringService#getLanguageData(Locale)}, as there are resolution
     * strategies in place if the initial locale is too specific.
     *
     * @return The locale the language data is representing
     */
    Locale getLocale();

}