DisplayableComparator.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * SteelBlue: DCI User Interfaces
  5.  * http://tidalwave.it/projects/steelblue
  6.  *
  7.  * Copyright (C) 2015 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
  8.  *
  9.  * *************************************************************************************************************************************************************
  10.  *
  11.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
  12.  * You may obtain a copy of the License at
  13.  *
  14.  *     http://www.apache.org/licenses/LICENSE-2.0
  15.  *
  16.  * 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
  17.  * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
  18.  *
  19.  * *************************************************************************************************************************************************************
  20.  *
  21.  * git clone https://bitbucket.org/tidalwave/steelblue-src
  22.  * git clone https://github.com/tidalwave-it/steelblue-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.ui.core.role.impl;

  27. import jakarta.annotation.Nonnull;
  28. import java.text.Collator;
  29. import java.util.Comparator;
  30. import java.io.Serializable;
  31. import it.tidalwave.ui.core.role.Displayable;
  32. import lombok.AccessLevel;
  33. import lombok.NoArgsConstructor;

  34. /***************************************************************************************************************************************************************
  35.  *
  36.  * A {@link Comparator} for classes implementing the {@link Displayable} role.
  37.  * FIXME: don't use it, it requires the objects to statically implement Displayable
  38.  *
  39.  * @author  Fabrizio Giudici
  40.  * @it.tidalwave.javadoc.draft Will be removed (FIXME)
  41.  *
  42.  **************************************************************************************************************************************************************/
  43. @NoArgsConstructor(access = AccessLevel.PRIVATE)
  44. public final class DisplayableComparator implements Comparator<Displayable>, Serializable
  45.   {
  46.     private static final long serialVersionUID = 434703962103322234L;

  47.     private static final DisplayableComparator INSTANCE = new DisplayableComparator();

  48.     @Nonnull
  49.     public static DisplayableComparator getInstance()
  50.       {
  51.         return INSTANCE;
  52.       }

  53.     @Override
  54.     public int compare (@Nonnull final Displayable d1, @Nonnull final Displayable d2)
  55.       {
  56.         return Collator.getInstance().compare(d1.getDisplayName(), d2.getDisplayName());
  57.       }
  58.   }