summaryrefslogtreecommitdiff
path: root/gee/abstractqueue.vala
blob: ce3fc3d3610a4a8fd4d1f79e41f4ddedfb754ffc (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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/* abstractqueue.vala
 *
 * Copyright (C) 2009  Didier Villevalois
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.

 * This library 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
 * Lesser General Public License for more details.

 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
 *
 * Author:
 * 	Didier 'Ptitjes Villevalois <ptitjes@free.fr>
 */

/**
 * Skeletal implementation of the {@link Queue} interface.
 *
 * Contains common code shared by all queue implementations.
 *
 * @see PriorityQueue
 */
public abstract class Gee.AbstractQueue<G> : Gee.AbstractCollection<G>, Queue<G> {
	/**
	 * {@inheritDoc}
	 */
	public abstract int capacity { get; }

	/**
	 * {@inheritDoc}
	 */
	public abstract int remaining_capacity { get; }

	/**
	 * {@inheritDoc}
	 */
	public abstract bool is_full { get; }

	/**
	 * {@inheritDoc}
	 */
	public abstract bool offer (G element);

	/**
	 * {@inheritDoc}
	 */
	public abstract G? peek ();

	/**
	 * {@inheritDoc}
	 */
	public abstract G? poll ();

	/**
	 * {@inheritDoc}
	 */
	public abstract int drain (Collection<G> recipient, int amount = -1);
}