1 package org.sentrysoftware.jawk.jrt;
2
3 /*-
4 * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
5 * Jawk
6 * ჻჻჻჻჻჻
7 * Copyright (C) 2006 - 2023 Sentry Software
8 * ჻჻჻჻჻჻
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
23 */
24
25 /**
26 * A list of keys into an associative array.
27 * <p>
28 * KeyList is provided to differentiate between associative
29 * array key lists and other types of lists on the operand stack
30 * or as contained by variables. However, this is the only
31 * List in used in this manner within Jawk at the time of
32 * this writing.
33 *
34 * @see KeyListImpl
35 * @author Danny Daglas
36 */
37 //public interface KeyList extends java.util.List<Object>
38 public interface KeyList {
39
40 /**
41 * Retrieve the number of elements in the KeyList.
42 *
43 * @return a int
44 */
45 int size();
46
47 /**
48 * <p>getFirstAndRemove.</p>
49 *
50 * @return a {@link java.lang.Object} object
51 */
52 Object getFirstAndRemove();
53 }