#96701# DataInputStream.idl DataOutputStream.idl MarkableInputStream.idl MarkableOutputStream.idl ObjectInputStream.idl ObjectOutputStream.idl Pipe.idl Pump.idl XDataInputStream.idl XDataOutputStream.idl XInputStream.idl XOutputStream.idl XPersistObject.idl

13 files changed, 137 insertions, 73 deletions

diff --git a/udkapi/com/sun/star/io/DataInputStream.idl b/udkapi/com/sun/star/io/DataInputStream.idl
index b9e65e3dc..67dc4b7e8 100644
--- a/udkapi/com/sun/star/io/DataInputStream.idl
+++ b/udkapi/com/sun/star/io/DataInputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: DataInputStream.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 14:45:32 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -76,28 +76,32 @@
  
 //============================================================================= 
  
-module com {  module sun {  module star {  module io {  
+module com {  module sun {  module star { module io {  
  
 //============================================================================= 
  
 // DocMerge from xml: service com::sun::star::io::DataInputStream
-/** reads the data through a chained stream.
+/** reads structured data from a chained <type>XInputStream</type>. 
 
-    @guarantees
-    <ul>
-    <li>- thread safe</li>
-    <li>- allow buffer size is 2 ^ 31 -1</li>
-    </ul>
+    <p> 
+    An implementation of this service in general does not need
+    to buffer data itself.
+
+    @see com::sun::star::io::ObjectInputStream
  */
 service DataInputStream
 { 
-    // DocMerge: empty anyway
+    /** allows to read structured data.
+     */
     interface com::sun::star::io::XDataInputStream; 
     
-    // DocMerge: empty anyway
+    /** used to plug the inputstream-data-source.
+        A plain input stream is sufficient.
+     */
     interface com::sun::star::io::XActiveDataSink; 
     
-    // DocMerge: empty anyway
+    /** Allows to chain the DataInputStream, so that
+     */
     interface com::sun::star::io::XConnectable; 
  
 }; 
@@ -109,6 +113,9 @@ service DataInputStream
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.6  2001/11/16 14:45:32  mi
+    proofing by Richard Holt
+    
     Revision 1.5  2000/12/11 16:09:49  mi
     documentation syntax fixed and some minor semantic documentation fixes
     
diff --git a/udkapi/com/sun/star/io/DataOutputStream.idl b/udkapi/com/sun/star/io/DataOutputStream.idl
index 862808273..76e1ba973 100644
--- a/udkapi/com/sun/star/io/DataOutputStream.idl
+++ b/udkapi/com/sun/star/io/DataOutputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: DataOutputStream.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -77,22 +77,23 @@ module com {  module sun {  module star {  module io {
 //============================================================================= 
  
 // DocMerge from xml: service com::sun::star::io::DataOutputStream
-/** writes its data to a chained <type>XOutputStream</type>. 
+/** writes structured data to a chained <type>XOutputStream</type>. 
     
-    @guarantees
-    <ul>
-    <li>-thread safe</li>
-    <li>-allow buffer size is 2 ^ 31 -1</li>
-    </ul>
+    <p> 
+    An implementation of this service in general does not need
+    to buffer data itself.
+
  */
 service DataOutputStream
 { 
-    // DocMerge: empty anyway
+    /** allows to write structured data.
+     */
     interface com::sun::star::io::XDataOutputStream; 
     
-    // DocMerge: empty anyway
+    /** used to plug the outputstream-data-sink.
+        <p>A plain output stream is sufficient.
+     */
     interface com::sun::star::io::XActiveDataSource; 
- 
 }; 
  
 //============================================================================= 
@@ -102,6 +103,9 @@ service DataOutputStream
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:49  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+    
     Revision 1.4  2000/11/08 12:28:36  mi
     moved from api
     
diff --git a/udkapi/com/sun/star/io/MarkableInputStream.idl b/udkapi/com/sun/star/io/MarkableInputStream.idl
index 415bc4cbf..21ab77a2d 100644
--- a/udkapi/com/sun/star/io/MarkableInputStream.idl
+++ b/udkapi/com/sun/star/io/MarkableInputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: MarkableInputStream.idl,v $
  *
- *  $Revision: 1.3 $
+ *  $Revision: 1.4 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -77,7 +77,7 @@
 module com {  module sun {  module star {  module io {  
  
 //==========================================================================
-/** allows to set marks in an InputStream and to later jump back to these
+/** allows to set marks in an inputstream and to later jump back to these
     marks.
 
     <p>The implementation reads the original data from the input stream,
@@ -86,10 +86,18 @@ module com {  module sun {  module star {  module io {
  */
 service MarkableInputStream
 { 
+    /** allows to access the data of this stream
+     */
     interface com::sun::star::io::XInputStream; 
 
+    /** allows to create marks at the current position
+        and to set the current position.
+     */
     interface com::sun::star::io::XMarkableStream; 
-    
+
+    /** allows to access to the underlying source
+        of this stream.
+     */
     interface com::sun::star::io::XActiveDataSink; 
     
     /** allows to navigate via a chain of streams */
diff --git a/udkapi/com/sun/star/io/MarkableOutputStream.idl b/udkapi/com/sun/star/io/MarkableOutputStream.idl
index bb4c14707..299189ef4 100644
--- a/udkapi/com/sun/star/io/MarkableOutputStream.idl
+++ b/udkapi/com/sun/star/io/MarkableOutputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: MarkableOutputStream.idl,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: jbu $ $Date: 2000-12-22 12:10:50 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -87,10 +87,17 @@ module com {  module sun {  module star {  module io {
  */
 service MarkableOutputStream
 { 
+    /** allows to write data at the current position */
     interface com::sun::star::io::XOutputStream; 
 
+    /** allows to create marks at the current position
+        and to set the current position.
+     */
     interface com::sun::star::io::XMarkableStream; 
     
+    /** allows to access to the underlying sink
+        of this stream.
+     */
     interface com::sun::star::io::XActiveDataSource; 
 
     /** allows to navigate via a chain of streams */
diff --git a/udkapi/com/sun/star/io/ObjectInputStream.idl b/udkapi/com/sun/star/io/ObjectInputStream.idl
index 6fa14bfa3..6f96dbe0e 100644
--- a/udkapi/com/sun/star/io/ObjectInputStream.idl
+++ b/udkapi/com/sun/star/io/ObjectInputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: ObjectInputStream.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -118,16 +118,18 @@
  */
 service ObjectInputStream
 { 
-    // DocMerge: empty anyway
+    /** allows to read the data from the stream.
+     */
     interface com::sun::star::io::XObjectInputStream; 
     
-    // DocMerge: empty anyway
+    /** allows to set the underlying inputstream */
     interface com::sun::star::io::XActiveDataSink; 
     
-    // DocMerge: empty anyway
+    /** allows to navigate via a chain of streams */
     interface com::sun::star::io::XConnectable; 
     
-    // DocMerge: empty anyway
+    /** allows to set marks within the stream. The implementation
+     may forward calls to this interface to a chained markablestream. */
     interface com::sun::star::io::XMarkableStream; 
  
 }; 
@@ -139,6 +141,9 @@ service ObjectInputStream
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:49  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+    
     Revision 1.4  2000/11/08 12:28:36  mi
     moved from api
     
diff --git a/udkapi/com/sun/star/io/ObjectOutputStream.idl b/udkapi/com/sun/star/io/ObjectOutputStream.idl
index 79eb3e798..99217c628 100644
--- a/udkapi/com/sun/star/io/ObjectOutputStream.idl
+++ b/udkapi/com/sun/star/io/ObjectOutputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: ObjectOutputStream.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 14:45:32 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -109,13 +109,14 @@ module com {  module sun {  module star {  module io {
  */
 service ObjectOutputStream
 { 
-    // DocMerge: empty anyway
+    /** allows to write the data to the stream.
+     */
     interface com::sun::star::io::XObjectOutputStream; 
     
-    // DocMerge: empty anyway
+    /** allows to set the underlying outputstream */
     interface com::sun::star::io::XActiveDataSource; 
     
-    // DocMerge: empty anyway
+    /** allows to navigate via a chain of streams */
     interface com::sun::star::io::XConnectable; 
  
 }; 
@@ -127,6 +128,9 @@ service ObjectOutputStream
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.6  2001/11/16 14:45:32  mi
+    proofing by Richard Holt
+    
     Revision 1.5  2000/12/11 16:09:49  mi
     documentation syntax fixed and some minor semantic documentation fixes
     
diff --git a/udkapi/com/sun/star/io/Pipe.idl b/udkapi/com/sun/star/io/Pipe.idl
index 084f83a99..1942a5bbc 100644
--- a/udkapi/com/sun/star/io/Pipe.idl
+++ b/udkapi/com/sun/star/io/Pipe.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: Pipe.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -79,15 +79,13 @@ module com {  module sun {  module star {  module io {
 // DocMerge from xml: service com::sun::star::io::Pipe
 /** the implementation of an output stream and an input stream. 
 
-    <p>All data written through the outputstream is buffered until it is 
-    read again from the input stream. The buffer grows in 2 ^ x steps. 
-    The maximum size of the buffer is 2 ^ 31 -1. </p>
-    
-    @guarantees
-    <ul>
-        <li>-thread safe </li>
-        <li>-allow buffer size is 2 ^ 31 -1 </li>
-    </ul>
+    <p>
+    All data written through the outputstream is buffered until it is 
+    read again from the input stream. Often two different threads access
+    input and outputstream.
+
+    <p> With the pipe-service, an outputstream can be converted into an
+    input stream at the cost of an additional buffer.
  */
 service Pipe
 { 
@@ -106,6 +104,9 @@ service Pipe
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:49  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+    
     Revision 1.4  2000/11/08 12:28:36  mi
     moved from api
     
diff --git a/udkapi/com/sun/star/io/Pump.idl b/udkapi/com/sun/star/io/Pump.idl
index 80e689e03..6b18afe4a 100644
--- a/udkapi/com/sun/star/io/Pump.idl
+++ b/udkapi/com/sun/star/io/Pump.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: Pump.idl,v $
  *
- *  $Revision: 1.5 $
+ *  $Revision: 1.6 $
  *
- *  last change: $Author: mi $ $Date: 2000-12-11 16:09:49 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -87,20 +87,18 @@
     the data to the connected output stream. Data will not be buffered by
     this service. </p>
     
-    @guarantees
-    <ul>
-        <li>thread safe</li>
-    </ul>
  */
 service Pump
 { 
-    // DocMerge: empty anyway
+    /** allows to set the outputstream
+     */
     interface com::sun::star::io::XActiveDataSource; 
     
-    // DocMerge: empty anyway
+    /** allows to set the inputstream
+     */
     interface com::sun::star::io::XActiveDataSink; 
-    
-    // DocMerge: empty anyway
+
+    /** allows listener administration and starting/stopping the pump */
     interface com::sun::star::io::XActiveDataControl; 
  
 }; 
@@ -112,6 +110,9 @@ service Pump
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.5  2000/12/11 16:09:49  mi
+    documentation syntax fixed and some minor semantic documentation fixes
+    
     Revision 1.4  2000/11/08 12:28:36  mi
     moved from api
     
diff --git a/udkapi/com/sun/star/io/XDataInputStream.idl b/udkapi/com/sun/star/io/XDataInputStream.idl
index 2fa4da8e0..3a95e16ba 100644
--- a/udkapi/com/sun/star/io/XDataInputStream.idl
+++ b/udkapi/com/sun/star/io/XDataInputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XDataInputStream.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: jsc $ $Date: 2001-03-16 15:10:36 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -79,6 +79,8 @@ module com {  module sun {  module star {  module io {
 // DocMerge from xml: interface com::sun::star::io::XDataInputStream
 /** makes it possible to read machine-independent simple data types from a
     stream.
+
+    @see com::sun::star::io::XDataOutputStream
  */
 interface XDataInputStream: com::sun::star::io::XInputStream
 { 
@@ -164,6 +166,9 @@ interface XDataInputStream: com::sun::star::io::XInputStream
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.6  2001/03/16 15:10:36  jsc
+    remove interfaceheader with uik and remove [const] in method definitions
+    
     Revision 1.5  2000/12/11 16:09:49  mi
     documentation syntax fixed and some minor semantic documentation fixes
     
diff --git a/udkapi/com/sun/star/io/XDataOutputStream.idl b/udkapi/com/sun/star/io/XDataOutputStream.idl
index 856d07648..b11960ce6 100644
--- a/udkapi/com/sun/star/io/XDataOutputStream.idl
+++ b/udkapi/com/sun/star/io/XDataOutputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XDataOutputStream.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: jsc $ $Date: 2001-03-16 15:10:36 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -79,6 +79,8 @@ module com {  module sun {  module star {  module io {
 // DocMerge from xml: interface com::sun::star::io::XDataOutputStream
 /** makes it possible to write machine-independent simple data types to a
     stream.
+
+    @see com::sun::star::io::XDataInputStream
  */
 interface XDataOutputStream: com::sun::star::io::XOutputStream
 { 
@@ -164,6 +166,9 @@ interface XDataOutputStream: com::sun::star::io::XOutputStream
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.6  2001/03/16 15:10:36  jsc
+    remove interfaceheader with uik and remove [const] in method definitions
+    
     Revision 1.5  2000/12/11 16:09:49  mi
     documentation syntax fixed and some minor semantic documentation fixes
     
diff --git a/udkapi/com/sun/star/io/XInputStream.idl b/udkapi/com/sun/star/io/XInputStream.idl
index 34596ff1a..29792f963 100644
--- a/udkapi/com/sun/star/io/XInputStream.idl
+++ b/udkapi/com/sun/star/io/XInputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XInputStream.idl,v $
  *
- *  $Revision: 1.9 $
+ *  $Revision: 1.10 $
  *
- *  last change: $Author: mi $ $Date: 2001-11-16 14:45:32 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -82,6 +82,10 @@ module com {  module sun {  module star {  module io {
  
 // DocMerge from xml: interface com::sun::star::io::XInputStream
 /** This is the basic interface to read data from a stream.
+
+    <p>
+    See the <a href="http://udk.openoffice.org/common/man/concept/streams.html">
+    streaming document</a> for further information on chaining and piping streams.
  */
 interface XInputStream: com::sun::star::uno::XInterface
 { 
@@ -192,6 +196,9 @@ interface XInputStream: com::sun::star::uno::XInterface
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.9  2001/11/16 14:45:32  mi
+    proofing by Richard Holt
+    
     Revision 1.8  2001/05/03 12:37:21  jbu
     removed a typo
     
diff --git a/udkapi/com/sun/star/io/XOutputStream.idl b/udkapi/com/sun/star/io/XOutputStream.idl
index e8b6588f8..0e0e8bb8d 100644
--- a/udkapi/com/sun/star/io/XOutputStream.idl
+++ b/udkapi/com/sun/star/io/XOutputStream.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XOutputStream.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: jsc $ $Date: 2001-03-16 15:10:36 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -82,6 +82,9 @@ module com {  module sun {  module star {  module io {
  
 // DocMerge from xml: interface com::sun::star::io::XOutputStream
 /** This is the basic interface to write data to a stream.
+    <p>
+    See the <a href="http://udk.openoffice.org/common/man/concept/streams.html">
+    streaming document</a> for further information on chaining and piping streams.
  */
 interface XOutputStream: com::sun::star::uno::XInterface
 { 
@@ -110,7 +113,7 @@ interface XOutputStream: com::sun::star::uno::XInterface
     // DocMerge from xml: method com::sun::star::io::XOutputStream::closeOutput
     /** gets called to indicate that all data has been written. 
         
-        <p>If this method is not yet been called, no attached 
+        <p>If this method has not yet been called, no attached 
         <type>XInputStream</type> receives an EOF signal. No further
         bytes may be written after this method has been called.</p>
      */
@@ -128,6 +131,9 @@ interface XOutputStream: com::sun::star::uno::XInterface
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.6  2001/03/16 15:10:36  jsc
+    remove interfaceheader with uik and remove [const] in method definitions
+    
     Revision 1.5  2000/12/11 16:09:49  mi
     documentation syntax fixed and some minor semantic documentation fixes
     
diff --git a/udkapi/com/sun/star/io/XPersistObject.idl b/udkapi/com/sun/star/io/XPersistObject.idl
index 9e9f42814..b4f0a33c3 100644
--- a/udkapi/com/sun/star/io/XPersistObject.idl
+++ b/udkapi/com/sun/star/io/XPersistObject.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XPersistObject.idl,v $
  *
- *  $Revision: 1.6 $
+ *  $Revision: 1.7 $
  *
- *  last change: $Author: jsc $ $Date: 2001-03-16 15:10:36 $
+ *  last change: $Author: jbu $ $Date: 2002-01-18 13:41:36 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -91,7 +91,8 @@ interface XPersistObject: com::sun::star::uno::XInterface
             the service name that specifies the behavior and the  
             persistent data format of this implementation.  
          
-        <p>This name can be used to create such an object by a factory. </p>
+        <p>This name can be used to create such an object by a factory
+        during deserialization. </p>
          
         @see XServiceName::getServiceName
      */
@@ -122,6 +123,9 @@ interface XPersistObject: com::sun::star::uno::XInterface
 /*============================================================================= 
  
     $Log: not supported by cvs2svn $
+    Revision 1.6  2001/03/16 15:10:36  jsc
+    remove interfaceheader with uik and remove [const] in method definitions
+    
     Revision 1.5  2000/12/11 16:09:49  mi
     documentation syntax fixed and some minor semantic documentation fixes