com.helger.commons.text.resolve.IEnumTextResolver 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-2024 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.resolve;

import java.util.Locale;

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

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

/**
 * Base interface for an enum-based text resolver.
 *
 * @author Philip Helger
 */
public interface IEnumTextResolver
{
  /**
   * Get the text of an enumeration item.
   *
   * @param aEnum
   *        The enumeration item to get the unique ID of. May not be
   *        null.
   * @param aTP
   *        The text provider containing the text. May not be null.
   * @param aContentLocale
   *        The locale to be used. May not be null.
   * @return null if no text could be resolved.
   */
  @Nullable
  String getText (@Nonnull Enum  aEnum, @Nonnull IHasText aTP, @Nonnull Locale aContentLocale);

  /**
   * Get the text of an enumeration item.
   *
   * @param aEnum
   *        The enumeration item to get the unique ID of. May not be
   *        null.
   * @param aTP
   *        The text provider containing the text. May not be null.
   * @param aContentLocale
   *        The locale to be used. May not be null.
   * @return null if no text could be resolved.
   * @deprecated Don't call this; Use {@link #getText(Enum, IHasText, Locale)}
   *             instead when no argument is needed
   */
  @Nullable
  @Deprecated (forRemoval = false)
  @DevelopersNote ("Use getText instead when no argument is needed")
  default String getTextWithArgs (@Nonnull final Enum  aEnum,
                                  @Nonnull final IHasTextWithArgs aTP,
                                  @Nonnull final Locale aContentLocale)
  {
    return getText (aEnum, aTP, aContentLocale);
  }

  /**
   * Get the text of an enumeration item with placeholder texts being replaced.
   *
   * @param aEnum
   *        The enumeration item to get the unique ID of. May not be
   *        null.
   * @param aTP
   *        The text provider containing the text. May not be null.
   * @param aContentLocale
   *        The locale to be used. May not be null.
   * @param aArgs
   *        The arguments to be added into the string. May be null
   *        but this makes no sense.
   * @return null if no text could be resolved.
   */
  @Nullable
  default String getTextWithArgs (@Nonnull final Enum  aEnum,
                                  @Nonnull final IHasTextWithArgs aTP,
                                  @Nonnull final Locale aContentLocale,
                                  @Nullable final Object... aArgs)
  {
    final String sText = getText (aEnum, aTP, aContentLocale);
    // And if something was found, resolve the arguments
    return TextHelper.getFormattedText (sText, aArgs);
  }
}