|
21 | 21 | import java.util.function.Predicate;
|
22 | 22 |
|
23 | 23 | /**
|
24 |
| - * This utility class contains useful lambdas for {@link java.util.Deque}. |
| 24 | + * This utility class contains useful lambdas for {@link Deque} |
25 | 25 | *
|
26 | 26 | * @author Grig Alex
|
27 |
| - * @version 0.1.1 |
28 |
| - * @see java.util.Deque |
29 |
| - * @see java.util.function.Consumer |
30 |
| - * @see java.util.function.Predicate |
| 27 | + * @see Deque |
| 28 | + * @see Consumer |
| 29 | + * @see Predicate |
31 | 30 | * @since 0.1.0
|
32 | 31 | */
|
33 | 32 | public final class DequeX {
|
34 | 33 | private DequeX() {
|
35 | 34 | }
|
36 | 35 |
|
37 |
| - /** |
38 |
| - * <p>Returns the carrying of {@link java.util.Deque#contains(Object)}: |
39 |
| - * item -> deque -> deque.contains(item).</p> |
40 |
| - * |
41 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#contains(Object)} |
42 |
| - * @param <E> a type of elements in a deque. |
43 |
| - * @return a {@link java.util.function.Predicate}. |
44 |
| - * @see java.util.Deque#contains(Object) |
45 |
| - * @see java.util.function.Predicate |
46 |
| - * @since 0.1.0 |
47 |
| - */ |
48 | 36 | public static <E> Predicate<Deque<? super E>> contains(E item) {
|
49 | 37 | return d -> d.contains(item);
|
50 | 38 | }
|
51 | 39 |
|
52 |
| - /** |
53 |
| - * <p>Returns the carrying of {@link java.util.Deque#add(Object)}: |
54 |
| - * item -> deque -> deque.add(item).</p> |
55 |
| - * |
56 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#add(Object)} |
57 |
| - * @param <E> a type of elements in a deque. |
58 |
| - * @return a {@link java.util.function.Predicate}. |
59 |
| - * @see java.util.Deque#add(Object) |
60 |
| - * @see java.util.function.Predicate |
61 |
| - * @since 0.1.0 |
62 |
| - */ |
63 | 40 | public static <E> Predicate<Deque<? super E>> add(E item) {
|
64 | 41 | return d -> d.add(item);
|
65 | 42 | }
|
66 | 43 |
|
67 |
| - /** |
68 |
| - * <p>Returns the carrying of {@link java.util.Deque#add(Object)}: |
69 |
| - * item -> deque -> deque.add(item).</p> |
70 |
| - * |
71 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#add(Object)} |
72 |
| - * @param <E> a type of elements in a deque. |
73 |
| - * @return a {@link java.util.function.Consumer}. |
74 |
| - * @see java.util.Deque#add(Object) |
75 |
| - * @see java.util.function.Consumer |
76 |
| - * @since 0.1.0 |
77 |
| - */ |
78 | 44 | public static <E> Consumer<Deque<? super E>> onlyAdd(E item) {
|
79 | 45 | return d -> d.add(item);
|
80 | 46 | }
|
81 | 47 |
|
82 |
| - /** |
83 |
| - * <p>Returns the carrying of {@link java.util.Deque#addFirst(Object)}: |
84 |
| - * item -> deque -> deque.addFirst(item).</p> |
85 |
| - * |
86 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#addFirst(Object)} |
87 |
| - * @param <E> a type of elements in a deque. |
88 |
| - * @return a {@link java.util.function.Consumer}. |
89 |
| - * @see java.util.Deque#addFirst(Object) |
90 |
| - * @see java.util.function.Consumer |
91 |
| - * @since 0.1.0 |
92 |
| - */ |
93 | 48 | public static <E> Consumer<Deque<? super E>> addFirst(E item) {
|
94 | 49 | return d -> d.addFirst(item);
|
95 | 50 | }
|
96 | 51 |
|
97 |
| - /** |
98 |
| - * <p>Returns the carrying of {@link java.util.Deque#addLast(Object)}: |
99 |
| - * item -> deque -> deque.addLast(item).</p> |
100 |
| - * |
101 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#addLast(Object)} |
102 |
| - * @param <E> a type of elements in a deque. |
103 |
| - * @return a {@link java.util.function.Consumer}. |
104 |
| - * @see java.util.Deque#addLast(Object) |
105 |
| - * @see java.util.function.Consumer |
106 |
| - * @since 0.1.0 |
107 |
| - */ |
108 | 52 | public static <E> Consumer<Deque<? super E>> addLast(E item) {
|
109 | 53 | return d -> d.addLast(item);
|
110 | 54 | }
|
111 | 55 |
|
112 |
| - /** |
113 |
| - * <p>Returns the carrying of {@link java.util.Deque#offer(Object)}: |
114 |
| - * item -> deque -> deque.offer(item).</p> |
115 |
| - * |
116 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#offer(Object)} |
117 |
| - * @param <E> a type of elements in a deque. |
118 |
| - * @return a {@link java.util.function.Predicate}. |
119 |
| - * @see java.util.Deque#offer(Object) |
120 |
| - * @see java.util.function.Predicate |
121 |
| - * @since 0.1.0 |
122 |
| - */ |
123 | 56 | public static <E> Predicate<Deque<? super E>> offer(E item) {
|
124 | 57 | return d -> d.offer(item);
|
125 | 58 | }
|
126 | 59 |
|
127 |
| - /** |
128 |
| - * <p>Returns the carrying of {@link java.util.Deque#offer(Object)}: |
129 |
| - * item -> deque -> deque.offer(item).</p> |
130 |
| - * |
131 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#offer(Object)} |
132 |
| - * @param <E> a type of elements in a deque. |
133 |
| - * @return a {@link java.util.function.Consumer}. |
134 |
| - * @see java.util.Deque#offer(Object) |
135 |
| - * @see java.util.function.Consumer |
136 |
| - * @since 0.1.0 |
137 |
| - */ |
138 | 60 | public static <E> Consumer<Deque<? super E>> onlyOffer(E item) {
|
139 | 61 | return d -> d.offer(item);
|
140 | 62 | }
|
141 | 63 |
|
142 |
| - /** |
143 |
| - * <p>Returns the carrying of {@link java.util.Deque#offerFirst(Object)}: |
144 |
| - * item -> deque -> deque.offerFirst(item).</p> |
145 |
| - * |
146 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#offerFirst(Object)} |
147 |
| - * @param <E> a type of elements in a deque. |
148 |
| - * @return a {@link java.util.function.Predicate}. |
149 |
| - * @see java.util.Deque#offerFirst(Object) |
150 |
| - * @see java.util.function.Predicate |
151 |
| - * @since 0.1.0 |
152 |
| - */ |
153 | 64 | public static <E> Predicate<Deque<? super E>> offerFirst(E item) {
|
154 | 65 | return d -> d.offerFirst(item);
|
155 | 66 | }
|
156 | 67 |
|
157 |
| - /** |
158 |
| - * <p>Returns the carrying of {@link java.util.Deque#offerFirst(Object)}: |
159 |
| - * item -> deque -> deque.offerFirst(item).</p> |
160 |
| - * |
161 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#offerFirst(Object)} |
162 |
| - * @param <E> a type of elements in a deque. |
163 |
| - * @return a {@link java.util.function.Consumer}. |
164 |
| - * @see java.util.Deque#offerFirst(Object) |
165 |
| - * @see java.util.function.Consumer |
166 |
| - * @since 0.1.0 |
167 |
| - */ |
168 | 68 | public static <E> Consumer<Deque<? super E>> onlyOfferFirst(E item) {
|
169 | 69 | return d -> d.offerFirst(item);
|
170 | 70 | }
|
171 | 71 |
|
172 |
| - /** |
173 |
| - * <p>Returns the carrying of {@link java.util.Deque#offerLast(Object)}: |
174 |
| - * item -> deque -> deque.offerLast(item).</p> |
175 |
| - * |
176 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#offerLast(Object)} |
177 |
| - * @param <E> a type of elements in a deque. |
178 |
| - * @return a {@link java.util.function.Predicate}. |
179 |
| - * @see java.util.Deque#offerLast(Object) |
180 |
| - * @see java.util.function.Predicate |
181 |
| - * @since 0.1.0 |
182 |
| - */ |
183 | 72 | public static <E> Predicate<Deque<? super E>> offerLast(E item) {
|
184 | 73 | return d -> d.offerLast(item);
|
185 | 74 | }
|
186 | 75 |
|
187 |
| - /** |
188 |
| - * <p>Returns the carrying of {@link java.util.Deque#offerLast(Object)}: |
189 |
| - * item -> deque -> deque.offerLast(item).</p> |
190 |
| - * |
191 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#offerLast(Object)} |
192 |
| - * @param <E> a type of elements in a deque. |
193 |
| - * @return a {@link java.util.function.Consumer}. |
194 |
| - * @see java.util.Deque#offerLast(Object) |
195 |
| - * @see java.util.function.Consumer |
196 |
| - * @since 0.1.0 |
197 |
| - */ |
198 | 76 | public static <E> Consumer<Deque<? super E>> onlyOfferLast(E item) {
|
199 | 77 | return d -> d.offerLast(item);
|
200 | 78 | }
|
201 | 79 |
|
202 |
| - /** |
203 |
| - * <p>Returns the carrying of {@link java.util.Deque#push(Object)}: |
204 |
| - * item -> deque -> deque.push(item).</p> |
205 |
| - * |
206 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#push(Object)} |
207 |
| - * @param <E> a type of elements in a deque. |
208 |
| - * @return a {@link java.util.function.Consumer}. |
209 |
| - * @see java.util.Deque#push(Object) |
210 |
| - * @see java.util.function.Consumer |
211 |
| - * @since 0.1.0 |
212 |
| - */ |
213 | 80 | public static <E> Consumer<Deque<? super E>> push(E item) {
|
214 | 81 | return d -> d.push(item);
|
215 | 82 | }
|
216 | 83 |
|
217 |
| - /** |
218 |
| - * <p>Returns the carrying of {@link java.util.Deque#remove(Object)}: |
219 |
| - * item -> deque -> deque.remove(item).</p> |
220 |
| - * |
221 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#remove(Object)} |
222 |
| - * @param <E> a type of elements in a deque. |
223 |
| - * @return a {@link java.util.function.Predicate}. |
224 |
| - * @see java.util.Deque#remove(Object) |
225 |
| - * @see java.util.function.Predicate |
226 |
| - * @since 0.1.0 |
227 |
| - */ |
228 | 84 | public static <E> Predicate<Deque<? super E>> remove(E item) {
|
229 | 85 | return d -> d.remove(item);
|
230 | 86 | }
|
231 | 87 |
|
232 |
| - /** |
233 |
| - * <p>Returns the carrying of {@link java.util.Deque#remove(Object)}: |
234 |
| - * item -> deque -> deque.remove(item).</p> |
235 |
| - * |
236 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#remove(Object)} |
237 |
| - * @param <E> a type of elements in a deque. |
238 |
| - * @return a {@link java.util.function.Consumer}. |
239 |
| - * @see java.util.Deque#remove(Object) |
240 |
| - * @see java.util.function.Consumer |
241 |
| - * @since 0.1.0 |
242 |
| - */ |
243 | 88 | public static <E> Consumer<Deque<? super E>> onlyRemove(E item) {
|
244 | 89 | return d -> d.remove(item);
|
245 | 90 | }
|
246 | 91 |
|
247 |
| - /** |
248 |
| - * <p>Returns the carrying of {@link java.util.Deque#removeFirstOccurrence(Object)}: |
249 |
| - * item -> deque -> deque.removeFirstOccurrence(item).</p> |
250 |
| - * |
251 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#removeFirstOccurrence(Object)} |
252 |
| - * @param <E> a type of elements in a deque. |
253 |
| - * @return a {@link java.util.function.Predicate}. |
254 |
| - * @see java.util.Deque#removeFirstOccurrence(Object) |
255 |
| - * @see java.util.function.Predicate |
256 |
| - * @since 0.1.0 |
257 |
| - */ |
258 | 92 | public static <E> Predicate<Deque<? super E>> removeFirstOccurrence(E item) {
|
259 | 93 | return d -> d.removeFirstOccurrence(item);
|
260 | 94 | }
|
261 | 95 |
|
262 |
| - /** |
263 |
| - * <p>Returns the carrying of {@link java.util.Deque#removeFirstOccurrence(Object)}: |
264 |
| - * item -> deque -> deque.removeFirstOccurrence(item).</p> |
265 |
| - * |
266 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#removeFirstOccurrence(Object)} |
267 |
| - * @param <E> a type of elements in a deque. |
268 |
| - * @return a {@link java.util.function.Consumer}. |
269 |
| - * @see java.util.Deque#removeFirstOccurrence(Object) |
270 |
| - * @see java.util.function.Consumer |
271 |
| - * @since 0.1.0 |
272 |
| - */ |
273 | 96 | public static <E> Consumer<Deque<? super E>> onlyRemoveFirstOccurrence(E item) {
|
274 | 97 | return d -> d.removeFirstOccurrence(item);
|
275 | 98 | }
|
276 | 99 |
|
277 |
| - /** |
278 |
| - * <p>Returns the carrying of {@link java.util.Deque#removeLastOccurrence(Object)}: |
279 |
| - * item -> deque -> deque.removeLastOccurrence(item).</p> |
280 |
| - * |
281 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#removeLastOccurrence(Object)} |
282 |
| - * @param <E> a type of elements in a deque. |
283 |
| - * @return a {@link java.util.function.Predicate}. |
284 |
| - * @see java.util.Deque#removeLastOccurrence(Object) |
285 |
| - * @see java.util.function.Predicate |
286 |
| - * @since 0.1.0 |
287 |
| - */ |
288 | 100 | public static <E> Predicate<Deque<? super E>> removeLastOccurrence(E item) {
|
289 | 101 | return d -> d.removeLastOccurrence(item);
|
290 | 102 | }
|
291 | 103 |
|
292 |
| - /** |
293 |
| - * <p>Returns the carrying of {@link java.util.Deque#removeLastOccurrence(Object)}: |
294 |
| - * item -> deque -> deque.removeLastOccurrence(item).</p> |
295 |
| - * |
296 |
| - * @param item an element of {@link E} that is passed as the argument to {@link java.util.Deque#removeLastOccurrence(Object)} |
297 |
| - * @param <E> a type of elements in a deque. |
298 |
| - * @return a {@link java.util.function.Consumer}. |
299 |
| - * @see java.util.Deque#removeLastOccurrence(Object) |
300 |
| - * @see java.util.function.Consumer |
301 |
| - * @since 0.1.0 |
302 |
| - */ |
303 | 104 | public static <E> Consumer<Deque<? super E>> onlyRemoveLastOccurrence(E item) {
|
304 | 105 | return d -> d.removeLastOccurrence(item);
|
305 | 106 | }
|
|
0 commit comments