3 namespace Org\Mxchange\CoreFramework\Compressor;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
9 * An interface for compression classes
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface Compressor extends FrameworkInterface {
32 * A compression stream
34 * @param $streamData Mixed non-object stream data
35 * @return $streamData The compressed stream data
36 * @throws InvalidArgumentException If the stream is not compressable or decompressable
38 function compressStream ($streamData);
41 * A decompression stream
43 * @param $streamData Mixed non-object stream data
44 * @return $streamData The decompressed stream data
45 * @throws InvalidArgumentException If the stream is not compressable or decompressable
47 function decompressStream ($streamData);
50 * Getter for the file extension of this compressor
52 * @return $string The compressor's file extension
54 function getCompressorExtension ();