3 * Null compression and decompression class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.mxchange.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 class NullCompressor extends BaseFrameworkSystem implements Compressor {
30 private function __construct () {
31 // Call parent constructor!
32 parent::constructor(__CLASS__);
35 if (((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
40 $this->setPartDescr("Null-Kompressor");
42 // Create an unique ID
43 $this->createUniqueID();
47 * Create a new compressor channel based a given compression handler
49 * @return $cInstance An instance of this class
51 public final static function createNullCompressor () {
53 $cInstance = new NullCompressor();
55 // Return the compressor instance
60 * Null compression stream
62 * @param $streamData Mixed non-object stream data
63 * @return $streamData The compressed stream data
64 * @throws InvalidObjectException If the stream is an object
66 public function compressStream ($streamData) {
67 if (is_object($streamData)) {
69 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
72 // Return the compressed stream
77 * Null decompression stream
79 * @param $streamData Mixed non-object stream data
80 * @return $streamData The decompressed stream data
81 * @throws InvalidObjectException If the stream is an object
83 public function decompressStream ($streamData) {
84 if (is_object($streamData)) {
86 throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT);
89 // Return the decompressed stream
94 * Getter for the file extension of this compressor
96 * @return $string Returns always "bz2"
98 public final function getCompressorExtension () {
99 if ((defined('DEBUG_COMPRESSOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Dateierweiterung angefordert.<br />\n",