View Javadoc
1   /*
2    * *************************************************************************************************************************************************************
3    *
4    * TheseFoolishThings: Miscellaneous utilities
5    * http://tidalwave.it/projects/thesefoolishthings
6    *
7    * Copyright (C) 2009 - 2024 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/thesefoolishthings-src
22   * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23   *
24   * *************************************************************************************************************************************************************
25   */
26  package it.tidalwave.role.ui.impl;
27  
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   *
35   * A {@link Comparator} for classes implementing the {@link Displayable} role.
36   * FIXME: don't use it, it requires the objects to statically implement Displayable
37   *
38   * @author  Fabrizio Giudici
39   * @it.tidalwave.javadoc.draft Will be removed (FIXME)
40   *
41   **************************************************************************************************************************************************************/
42  public final class DisplayableComparator implements Comparator<Displayable>
43    {
44      private static final DisplayableComparator INSTANCE = new DisplayableComparator();
45  
46      @Nonnull
47      public static DisplayableComparator getInstance()
48        {
49          return INSTANCE;
50        }
51  
52      @Override
53      public int compare (@Nonnull final Displayable d1, @Nonnull final Displayable d2)
54        {
55          return Collator.getInstance().compare(d1.getDisplayName(), d2.getDisplayName());
56        }
57    }