Sortable.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 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/thesefoolishthings-src
  22.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.role;

  27. import jakarta.annotation.Nonnull;
  28. import it.tidalwave.util.Finder;
  29. import it.tidalwave.util.Finder.SortCriterion;
  30. import it.tidalwave.util.Finder.SortDirection;

  31. /***************************************************************************************************************************************************************
  32.  *
  33.  * The role of an object that has contents that can be sorted.
  34.  *
  35.  * @author  Fabrizio Giudici
  36.  * @it.tidalwave.javadoc.stable
  37.  *
  38.  **************************************************************************************************************************************************************/
  39. public interface Sortable
  40.   {
  41.     /** Shortcut for {@link it.tidalwave.util.As}. */
  42.     public static final Class<Sortable> _Sortable_ = Sortable.class;

  43.     /***********************************************************************************************************************************************************
  44.      * A default {@code Sortable} which does nothing (useful for implementing the NullObject pattern). This object always returns
  45.      * {@link SortCriterion#UNSORTED} as {@code sortCriterion} and {@link SortDirection#ASCENDING} as {@code sortDirection}.
  46.      **********************************************************************************************************************************************************/
  47.     public static final Sortable DEFAULT = new Sortable()
  48.       {
  49.         @Override
  50.         public void setSortCriterion (@Nonnull final SortCriterion sortCriterion)
  51.           {
  52.           }

  53.         @Override @Nonnull
  54.         public SortCriterion getSortCriterion()
  55.           {
  56.             return Finder.SortCriterion.UNSORTED;
  57.           }

  58.         @Override
  59.         public void setSortDirection (@Nonnull final SortDirection sortDirection)
  60.           {
  61.           }

  62.         @Override @Nonnull
  63.         public SortDirection getSortDirection()
  64.           {
  65.             return SortDirection.ASCENDING;
  66.           }
  67.       };

  68.     /***********************************************************************************************************************************************************
  69.      * Sets the sort criterion.
  70.      * @param sortCriterion  the sort criterion
  71.      **********************************************************************************************************************************************************/
  72.     @SuppressWarnings("EmptyMethod")
  73.     public void setSortCriterion (@Nonnull SortCriterion sortCriterion);

  74.     /***********************************************************************************************************************************************************
  75.      * Sets the sort direction.
  76.      * @param sortDirection  the sort direction
  77.      **********************************************************************************************************************************************************/
  78.     @SuppressWarnings("EmptyMethod")
  79.     public void setSortDirection (@Nonnull SortDirection sortDirection);

  80.     /***********************************************************************************************************************************************************
  81.      * Returns the current sort criterion.
  82.      * @return  the sort criterion
  83.      **********************************************************************************************************************************************************/
  84.     @Nonnull @SuppressWarnings("SameReturnValue")
  85.     public SortCriterion getSortCriterion();

  86.     /***********************************************************************************************************************************************************
  87.      * Returns the current sort direction.
  88.      * @return  the sort direction
  89.      **********************************************************************************************************************************************************/
  90.     @Nonnull @SuppressWarnings("SameReturnValue")
  91.     public SortDirection getSortDirection();
  92.   }