com.helger.commons.text.display.IHasDisplayTextWithArgs Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2020 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.display;

import java.util.Locale;

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

import com.helger.commons.annotation.DevelopersNote;
import com.helger.commons.text.IHasTextWithArgs;
import com.helger.commons.text.util.TextHelper;

/**
 * Base interface for objects that have a locale dependent display name.
 * 

 * Since version 8.5.2 this interface inherits from IHasDisplayText and is
 * therefore Serializable. This was done to align it with IHasTextWithArgs
 *
 * @author Philip Helger
 */
@FunctionalInterface
public interface IHasDisplayTextWithArgs extends IHasDisplayText
{
  /**
   * @param aContentLocale
   *        The locale to be used for resolving. May not be null.
   * @return The display text of the object in the given locale. May be
   *         null if the text could not be resolved in the passed
   *         locale.
   * @deprecated Use {@link #getDisplayText(Locale)} if no parameters are
   *             present
   */
  @Nullable
  @Deprecated
  @DevelopersNote ("Use geDisplayText (Locale) instead")
  default String getDisplayTextWithArgs (@Nonnull final Locale aContentLocale)
  {
    return getDisplayText (aContentLocale);
  }

  /**
   * @param aContentLocale
   *        The locale to be used for resolving. May not be null.
   * @param aArgs
   *        Arguments for formatting the provided text. May be null
   *        but this makes no sense.
   * @return The display text of the object in the given locale. May be
   *         null if the text could not be resolved in the passed
   *         locale.
   */
  @Nullable
  default String getDisplayTextWithArgs (@Nonnull final Locale aContentLocale, @Nullable final Object... aArgs)
  {
    final String sText = getDisplayText (aContentLocale);
    return TextHelper.getFormattedText (sText, aArgs);
  }

  /**
   * @return this as an instance of {@link IHasTextWithArgs}.
   * @since 8.5.2
   */
  @Nonnull
  default IHasTextWithArgs getAsHasTextWithArgs ()
  {
    return this::getDisplayText;
  }
}