3 * An interface for file pointers
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 FilePointer extends FrameworkInterface {
26 * Getter for the file pointer
28 * @return $filePointer The file pointer which shall be a valid file resource
30 function getPointer ();
33 * Getter for file name
35 * @return $fileName The current file name
37 function getFileName ();
40 * Determines whether the EOF has been reached
42 * @return $isEndOfFileReached Whether the EOF has been reached
44 function isEndOfFileReached ();