3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filesystem\FilePointer;
7 use Org\Mxchange\CoreFramework\Stream\Input\StreamableInput;
10 * An interface for (mostly) file input pointers.
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 interface InputPointer extends StreamableInput, FilePointer {
33 * Read data a file pointer
35 * @return $data Read data from file
37 function readFromFile ();
40 * Reads a line, maximum 4096 Bytes from current file pointer
42 * @return $data Read data from file
47 * Reads given amount of bytes from file.
49 * @param $bytes Amount of bytes to read or whole line (only text files)
50 * @return $data Data read from file
51 * @throws NullPointerException If the file pointer instance
52 * is not set by setFileObject()
53 * @throws InvalidResourceException If there is being set
55 function read ($bytes = NULL);