DisplayableComparator.java

  1. /*
  2.  * *********************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2023 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
  12.  * the License. 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
  17.  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
  18.  * specific language governing permissions and limitations under the License.
  19.  *
  20.  * *********************************************************************************************************************
  21.  *
  22.  * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
  23.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  24.  *
  25.  * *********************************************************************************************************************
  26.  */
  27. package it.tidalwave.role.ui.impl;

  28. import javax.annotation.Nonnull;
  29. import java.text.Collator;
  30. import java.util.Comparator;
  31. import it.tidalwave.role.ui.Displayable;

  32. /***********************************************************************************************************************
  33.  *
  34.  * A {@link Comparator} for classes implementing the {@link Displayable} role.
  35.  * FIXME: don't use it, it requires the objects to statically implement Displayable
  36.  *
  37.  * @author  Fabrizio Giudici
  38.  * @it.tidalwave.javadoc.draft Will be removed (FIXME)
  39.  *
  40.  **********************************************************************************************************************/
  41. public final class DisplayableComparator implements Comparator<Displayable>
  42.   {
  43.     private static final DisplayableComparator INSTANCE = new DisplayableComparator();

  44.     private final Collator collator = Collator.getInstance();

  45.     @Nonnull
  46.     public static DisplayableComparator getInstance()
  47.       {
  48.         return INSTANCE;
  49.       }

  50.     @Override
  51.     public int compare (@Nonnull final Displayable d1, @Nonnull final Displayable d2)
  52.       {
  53.         return collator.compare(d1.getDisplayName(), d2.getDisplayName());
  54.       }
  55.   }