com.helger.commons.text.IMultilingualText Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.commons.text;

import java.util.Locale;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.annotation.MustImplementEqualsAndHashcode;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.collection.impl.ICommonsOrderedMap;

/**
 * Read-only interface for a multilingual text
 *
 * @author Philip Helger
 */
@MustImplementEqualsAndHashcode
public interface IMultilingualText extends IHasTextWithArgs
{
  /**
   * @return The Locale to text map. Never null.
   * @since 9.1.8
   */
  @Nonnull
  @ReturnsMutableObject
  ICommonsOrderedMap  texts ();

  /**
   * Check if the passed locale is directly or by fallback contained. The
   * implementation class MUST add locale-generalisation when resolving the text
   * ("de_DE" => "de" => default).
   *
   * @param aLocale
   *        The locale to check. May be null.
   * @return true if the locale is contained, false if
   *         not.
   */
  boolean containsLocaleWithFallback (@Nullable Locale aLocale);
}