summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/functypes/ArrayChooser.java
blob: d8619c53feeb15bfd21a0be2005bc548d8f7acdd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/* 
 * esodata - data structures and other things, of varying utility
 * Copyright 2022, Ben Culkin
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *   
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package bjc.functypes;

/**
 * Function which picks a single element from an array of elements.
 * 
 * @author Ben Culkin
 *
 * @param <ElementType> The type of element stored in the array.
 */
@FunctionalInterface
public interface ArrayChooser<ElementType> {
	/**
	 * Select a single element from an array of elements.
	 * 
	 * @param elements The elements to pick from.
	 * 
	 * @return The selected element.
	 */
	public ElementType choose(@SuppressWarnings("unchecked") ElementType... elements);
}