3 * A Stackable interface
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 interface Stackable extends FrameworkInterface {
26 * Pushs a value on a named stacker
28 * @param $stackerName Name of the stacker
29 * @param $value Value to push on it
31 * @throws StackerFullException If the stacker is full
33 function pushNamed ($stackerName, $value);
36 * 'Pops' a value from a named stacker and returns it's value
38 * @param $stackerName Name of the stacker
39 * @return $value Value of the current stack entry
40 * @throws NoStackerException If the named stacker was not found
41 * @throws EmptyStackerException If the named stacker is empty
43 function popNamed ($stackerName);
46 * Get value from named stacker but don't "pop" it
48 * @param $stackerName Name of the stacker
49 * @return $value Value of last added value
50 * @throws NoStackerException If the named stacker was not found
51 * @throws EmptyStackerException If the named stacker is empty
53 function getNamed ($stackerName);
56 * Checks whether the given stack is initialized (set in array $stackers)
58 * @param $stackerName Name of the stack
59 * @return $isInitialized Whether the stack is initialized
61 function isStackInitialized ($stackerName);
64 * Checks whether the given stack is empty
66 * @param $stackerName Name of the stack
67 * @return $isEmpty Whether the stack is empty
68 * @throws NoStackerException If given stack is missing
70 function isStackEmpty ($stackerName);