com.helger.commons.text.display.IHasDisplayText 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.display;

import java.util.Comparator;
import java.util.Locale;

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

import com.helger.commons.compare.IComparator;
import com.helger.commons.text.IHasText;

/**
 * Base interface for objects that have a locale dependent display name.
 *
 * @author Philip Helger
 */
@FunctionalInterface
public interface 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.
   */
  @Nullable
  String getDisplayText (@Nonnull Locale aContentLocale);

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

  @Nonnull
  static Comparator  getComparatorCollating (@Nonnull final Locale aContentLocale, @Nullable final Locale aSortLocale)
  {
    return IComparator.getComparatorCollating (x -> x.getDisplayText (aContentLocale), aSortLocale);
  }
}