Use JUnit 4 syntax, change some formatting
[Sone.git] / src / main / java / net / pterodactylus / sone / utils / IntegerRangePredicate.java
1 /*
2  * Sone - IntegerRangePredicate.java - Copyright © 2013 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.utils;
19
20 import com.google.common.base.Predicate;
21
22 /**
23  * {@link Predicate} that verifies that an {@link Integer} value is not
24  * {@code null} and is between a lower and an upper bound. Both bounds are
25  * inclusive.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public class IntegerRangePredicate implements Predicate<Integer> {
30
31         /** The lower bound. */
32         private final int lowerBound;
33
34         /** The upper bound. */
35         private final int upperBound;
36
37         /**
38          * Creates a new integer range predicate.
39          *
40          * @param lowerBound
41          *            The lower bound
42          * @param upperBound
43          *            The upper bound
44          */
45         public IntegerRangePredicate(int lowerBound, int upperBound) {
46                 this.lowerBound = lowerBound;
47                 this.upperBound = upperBound;
48         }
49
50         //
51         // PREDICATE METHODS
52         //
53
54         /**
55          * {@inheritDoc}
56          */
57         @Override
58         public boolean apply(Integer value) {
59                 return (value != null) && (value >= lowerBound) && (value <= upperBound);
60         }
61
62         public static IntegerRangePredicate range(int lowerBound, int upperBound) {
63                 return new IntegerRangePredicate(lowerBound, upperBound);
64         }
65
66 }