Method: getSortDirection()

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;
28:
29: import javax.annotation.Nonnull;
30: import it.tidalwave.util.Finder;
31: import it.tidalwave.util.Finder.SortCriterion;
32: import it.tidalwave.util.Finder.SortDirection;
33:
34: /***********************************************************************************************************************
35: *
36: * The role of an object that has contents that can be sorted.
37: *
38: * @author Fabrizio Giudici
39: * @it.tidalwave.javadoc.stable
40: *
41: **********************************************************************************************************************/
42: public interface Sortable
43: {
44: public static final Class<Sortable> _Sortable_ = Sortable.class;
45:
46: /*******************************************************************************************************************
47: *
48: * A default {@code Sortable} which does nothing (useful for implementing the NullObject pattern). This object
49: * always returns {@link SortCriterion#UNSORTED} as {@code sortCriterion} and {@link SortDirection#ASCENDING} as
50: * {@code sortDirection}.
51: *
52: ******************************************************************************************************************/
53: public static final Sortable DEFAULT = new Sortable()
54: {
55: @Override
56: public void setSortCriterion (@Nonnull final SortCriterion sortCriterion)
57: {
58: }
59:
60: @Override @Nonnull
61: public SortCriterion getSortCriterion()
62: {
63: return Finder.SortCriterion.UNSORTED;
64: }
65:
66: @Override
67: public void setSortDirection (@Nonnull final SortDirection sortDirection)
68: {
69: }
70:
71: @Override @Nonnull
72: public SortDirection getSortDirection()
73: {
74: return SortDirection.ASCENDING;
75: }
76: };
77:
78: /*******************************************************************************************************************
79: *
80: * Sets the sort criterion.
81: *
82: * @param sortCriterion the sort criterion
83: *
84: ******************************************************************************************************************/
85: @SuppressWarnings("EmptyMethod")
86: public void setSortCriterion (@Nonnull SortCriterion sortCriterion);
87:
88: /*******************************************************************************************************************
89: *
90: * Sets the sort direction.
91: *
92: * @param sortDirection the sort direction
93: *
94: ******************************************************************************************************************/
95: @SuppressWarnings("EmptyMethod")
96: public void setSortDirection (@Nonnull SortDirection sortDirection);
97:
98: /*******************************************************************************************************************
99: *
100: * Returns the current sort criterion.
101: *
102: * @return the sort criterion
103: *
104: ******************************************************************************************************************/
105: @Nonnull @SuppressWarnings("SameReturnValue")
106: public SortCriterion getSortCriterion();
107:
108: /*******************************************************************************************************************
109: *
110: * Returns the current sort direction.
111: *
112: * @return the sort direction
113: *
114: ******************************************************************************************************************/
115: @Nonnull @SuppressWarnings("SameReturnValue")
116: public SortDirection getSortDirection();
117: }