3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filesystem\FilePointer;
7 use Org\Mxchange\CoreFramework\Stream\Output\StreamableOutput;
10 * An interface for (mostly) file output pointers.
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 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 OutputPointer extends StreamableOutput, FilePointer {
33 * Write data to a file pointer
35 * @param $dataStream The data stream we shall write to the file
36 * @return mixed Number of writes bytes or false on error
37 * @throws NullPointerException If the file pointer instance
38 * is not set by setFileObject()
39 * @throws InvalidResourceException If there is being set
40 * an invalid file resource
42 function writeToFile (string $dataStream);
45 * Writes at given position by seeking to it.
47 * @param $seekPosition Seek position in file
48 * @param $data Data to be written
49 * @return mixed Number of writes bytes or false on error
51 function writeAtPosition (int $seedPosition, string $data);