framework/main/interfaces/compressor/class_Compressor.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Compressor;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An interface for compression classes
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13 <<<<<<< HEAD:framework/main/interfaces/compressor/class_Compressor.php
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15 =======
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  17 >>>>>>> Some updates::inc/main/interfaces/compressor/class_Compressor.php
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 interface Compressor extends FrameworkInterface {
  35         /**
  36          * A compression stream
  37          *
  38          * @param       $streamData             Mixed non-object stream data
  39          * @return      $streamData             The compressed stream data
  40          * @throws      InvalidObjectException  If the stream is an object
  41          */
  42         function compressStream ($streamData);
  43
  44         /**
  45          * A decompression stream
  46          *
  47          * @param       $streamData             Mixed non-object stream data
  48          * @return      $streamData             The decompressed stream data
  49          * @throws      InvalidObjectException  If the stream is an object
  50          */
  51         function decompressStream ($streamData);
  52
  53         /**
  54          * Getter for the file extension of this compressor
  55          *
  56          * @return      $string The compressor's file extension
  57          */
  58         function getCompressorExtension ();
  59
  60 }