Stream.st
branchjv
changeset 18397 20527009f352
parent 18334 3e18bee23c3a
parent 18394 80d135c6aecb
child 18482 68a43e2b3e78
--- a/Stream.st	Sat May 23 06:49:51 2015 +0200
+++ b/Stream.st	Mon May 25 02:51:46 2015 +0100
@@ -226,7 +226,6 @@
 ! !
 
 
-
 !Stream methodsFor:'accessing'!
 
 contents
@@ -318,6 +317,10 @@
 !Stream methodsFor:'converting'!
 
 asLineNumberReadStream
+    "returns a new stream, which keeps track of the line number.
+     It can be asked for the current linenumber, 
+     which is useful eg. for error message generation"
+
     ^ LineNumberReadStream on:self
 !
 
@@ -1962,10 +1965,20 @@
 !Stream methodsFor:'queries'!
 
 canReadWithoutBlocking
+    "return true, if the stream can be read without blocking the program (actually: suspending the thread).
+     This is redefined in external streams, which read from a communication line
+     (sockets and devices).
+     Always true here, because all internal streams never block"
+
     ^ true
 !
 
 canWriteWithoutBlocking
+    "return true, if the stream can be written without blocking the program (actually: suspending the thread).
+     This is redefined in external streams, which write to a communication line
+     (sockets and devices).
+     Always true here, because all internal streams never block"
+
     ^ true
 !
 
@@ -2933,10 +2946,14 @@
 !
 
 isEncodedStream
+    "true, iff this is an encoder/decoder stream"
+
     ^ false
 !
 
 isLineNumberReadStream
+    "true, iff this is a lineNumbering stream"
+
     ^ false
 !
 
@@ -2968,10 +2985,14 @@
 !
 
 isTerminalStream
+    "true, iff this is a terminal emulator stream"
+
     ^ false
 !
 
 isTextCollector
+    "true, iff this is a text collector emulating a stream"
+
     ^ false
 
     "
@@ -3785,11 +3806,11 @@
 !Stream class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic/Stream.st,v 1.243 2015-05-08 01:06:57 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/Stream.st,v 1.245 2015-05-23 13:09:26 cg Exp $'
 !
 
 version_CVS
-    ^ '$Header: /cvs/stx/stx/libbasic/Stream.st,v 1.243 2015-05-08 01:06:57 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/Stream.st,v 1.245 2015-05-23 13:09:26 cg Exp $'
 ! !