31f9a72631906911ca759d41e33aa8089f929a19
[core.git] / framework / main / classes / streams / output / class_
1 <?php
2 /**
3  * A ???OutputStream class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009  Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 class ???OutputStream extends BaseStream implements OutputStream {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this node class
37          *
38          * @return      $streamInstance         An instance of this node class
39          */
40         public final static function create???OutputStream () {
41                 // Get a new instance
42                 $streamInstance = new ???OutputStream();
43
44                 // Return the instance
45                 return $streamInstance;
46         }
47
48         /**
49          * Streams the data and maybe does something to it
50          *
51          * @param       $data   The data (string mostly) to "stream"
52          * @return      $data   The data (string mostly) to "stream"
53          * @throws      UnsupportedOperationException   If this method is called
54          */
55         public function streamData ($data) {
56                 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
57                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
58         }
59
60 }