Package: Sortable$1

Sortable$1

name	instruction	branch	complexity	line	method
getSortCriterion()	M: 2 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%
getSortDirection()	M: 2 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%
setSortCriterion(Finder.SortCriterion)	M: 1 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%
setSortDirection(Finder.SortDirection)	M: 1 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%
{...}	M: 3 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%

Coverage

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