com.liferay.portal.kernel.language.Language.java Source code

Introduction

Here is the source code for com.liferay.portal.kernel.language.Language.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.kernel.language;

import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.util.ResourceBundleLoader;

import java.util.List;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.Set;
import java.util.function.Supplier;

import javax.portlet.PortletRequest;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.osgi.annotation.versioning.ProviderType;

/**
 * @author Brian Wing Shun Chan
 */
@ProviderType
public interface Language {

    public String format(HttpServletRequest httpServletRequest, String pattern, LanguageWrapper argument);

    public String format(HttpServletRequest httpServletRequest, String pattern, LanguageWrapper argument,
            boolean translateArguments);

    public String format(HttpServletRequest httpServletRequest, String pattern, LanguageWrapper[] arguments);

    public String format(HttpServletRequest httpServletRequest, String pattern, LanguageWrapper[] arguments,
            boolean translateArguments);

    public String format(HttpServletRequest httpServletRequest, String pattern, Object argument);

    public String format(HttpServletRequest httpServletRequest, String pattern, Object argument,
            boolean translateArguments);

    public String format(HttpServletRequest httpServletRequest, String pattern, Object[] arguments);

    public String format(HttpServletRequest httpServletRequest, String pattern, Object[] arguments,
            boolean translateArguments);

    public String format(Locale locale, String pattern, List<Object> arguments);

    public String format(Locale locale, String pattern, Object argument);

    public String format(Locale locale, String pattern, Object argument, boolean translateArguments);

    public String format(Locale locale, String pattern, Object[] arguments);

    public String format(Locale locale, String pattern, Object[] arguments, boolean translateArguments);

    public String format(ResourceBundle resourceBundle, String pattern, Object argument);

    public String format(ResourceBundle resourceBundle, String pattern, Object argument,
            boolean translateArguments);

    public String format(ResourceBundle resourceBundle, String pattern, Object[] arguments);

    public String format(ResourceBundle resourceBundle, String pattern, Object[] arguments,
            boolean translateArguments);

    public String get(HttpServletRequest httpServletRequest, ResourceBundle resourceBundle, String key);

    public String get(HttpServletRequest httpServletRequest, ResourceBundle resourceBundle, String key,
            String defaultValue);

    public String get(HttpServletRequest httpServletRequest, String key);

    public String get(HttpServletRequest httpServletRequest, String key, String defaultValue);

    public String get(Locale locale, String key);

    public String get(Locale locale, String key, String defaultValue);

    public String get(ResourceBundle resourceBundle, String key);

    public String get(ResourceBundle resourceBundle, String key, String defaultValue);

    public Set<Locale> getAvailableLocales();

    public Set<Locale> getAvailableLocales(long groupId);

    public String getBCP47LanguageId(HttpServletRequest httpServletRequest);

    public String getBCP47LanguageId(Locale locale);

    public String getBCP47LanguageId(PortletRequest portletRequest);

    public Set<Locale> getCompanyAvailableLocales(long companyId);

    public String getLanguageId(HttpServletRequest httpServletRequest);

    public String getLanguageId(Locale locale);

    public String getLanguageId(PortletRequest portletRequest);

    public default long getLastModified() {
        return System.currentTimeMillis();
    }

    public Locale getLocale(long groupId, String languageCode);

    public Locale getLocale(String languageCode);

    public ResourceBundleLoader getPortalResourceBundleLoader();

    public Set<Locale> getSupportedLocales();

    public String getTimeDescription(HttpServletRequest httpServletRequest, long milliseconds);

    public String getTimeDescription(HttpServletRequest httpServletRequest, long milliseconds, boolean approximate);

    public String getTimeDescription(HttpServletRequest httpServletRequest, Long milliseconds);

    public String getTimeDescription(Locale locale, long milliseconds);

    public String getTimeDescription(Locale locale, long milliseconds, boolean approximate);

    public String getTimeDescription(Locale locale, Long milliseconds);

    public void init();

    public boolean isAvailableLanguageCode(String languageCode);

    public boolean isAvailableLocale(Locale locale);

    public boolean isAvailableLocale(long groupId, Locale locale);

    public boolean isAvailableLocale(long groupId, String languageId);

    public boolean isAvailableLocale(String languageId);

    public boolean isBetaLocale(Locale locale);

    public boolean isDuplicateLanguageCode(String languageCode);

    public boolean isInheritLocales(long groupId) throws PortalException;

    public boolean isSameLanguage(Locale locale1, Locale locale2);

    public String process(Supplier<ResourceBundle> resourceBundleSupplier, Locale locale, String content);

    public void resetAvailableGroupLocales(long groupId);

    public void resetAvailableLocales(long companyId);

    public void updateCookie(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse,
            Locale locale);

}