summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/io/ObjectOutputStream.idl
diff options
context:
space:
mode:
Diffstat (limited to 'udkapi/com/sun/star/io/ObjectOutputStream.idl')
-rw-r--r--udkapi/com/sun/star/io/ObjectOutputStream.idl96
1 files changed, 96 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/io/ObjectOutputStream.idl b/udkapi/com/sun/star/io/ObjectOutputStream.idl
new file mode 100644
index 000000000000..3669db12b723
--- /dev/null
+++ b/udkapi/com/sun/star/io/ObjectOutputStream.idl
@@ -0,0 +1,96 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_io_ObjectOutputStream_idl__
+#define __com_sun_star_io_ObjectOutputStream_idl__
+
+#ifndef __com_sun_star_io_XObjectOutputStream_idl__
+#include <com/sun/star/io/XObjectOutputStream.idl>
+#endif
+
+#ifndef __com_sun_star_io_XActiveDataSource_idl__
+#include <com/sun/star/io/XActiveDataSource.idl>
+#endif
+
+#ifndef __com_sun_star_io_XConnectable_idl__
+#include <com/sun/star/io/XConnectable.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module io {
+
+//=============================================================================
+
+// DocMerge from xml: service com::sun::star::io::ObjectOutputStream
+/** is a stream which allows writing the data of persistent objects.
+
+ <p>Implementations of this service must fulfill the specifications of the
+ <type>DataOutputStream</type> service; futhermore, the stream needs to be chained to a
+ <type>XMarkableStream</type>. Therefore, it also provides the <type>XMarkableStream</type>
+ interface, but it delegates the calls to the chained object.
+ The written objects are held until this instance is destroyed.
+ The references to the objects are written as four-byte integers
+ and begin at 1. Data format is written: </p>
+ <pre>
+ short InfoLength
+ long ObjectReference // 0 indicates no object
+ UTF ServiceName // length of 0 indicates this is only a reference
+ long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data
+ Object ObjectData // the data of the object
+ </pre>
+
+ @garantees
+ <ul>
+ <li>-thread safe </li>
+ <li>-allow buffer size is 2 ^ 31 -1 </li>
+ <li>-maximum object reference identifier is the number of objects. </li>
+ <li>-object reference identifier 0 indicates no object </li>
+ </ul>
+ */
+published service ObjectOutputStream
+{
+ /** allows to write the data to the stream.
+ */
+ interface com::sun::star::io::XObjectOutputStream;
+
+ /** allows to set the underlying outputstream */
+ interface com::sun::star::io::XActiveDataSource;
+
+ /** allows to navigate via a chain of streams */
+ interface com::sun::star::io::XConnectable;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+=============================================================================*/
+#endif