-
Notifications
You must be signed in to change notification settings - Fork 9
/
objectstream.html
200 lines (158 loc) · 9.18 KB
/
objectstream.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!--
Copyright (C) 2005, 2006 Joe Walnes.
Copyright (C) 2006, 2007, 2008, 2021 XStream committers.
All rights reserved.
The software in this package is published under the terms of the BSD
style license a copy of which has been included with this distribution in
the LICENSE.txt file.
Created on 29. January 2005 by Joe Walnes
-->
<head>
<title>XStream - Object Streams Tutorial</title>
<link rel="stylesheet" type="text/css" href="style.css"/>
<style type="text/css">.highlight {}</style>
<!-- Google analytics -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-110973-2";
urchinTracker();
</script>
</head>
<body>
<div id="banner">
<a href="index.html"><img id="logo" src="logo.gif" alt="XStream"/></a>
</div>
<div id="center" class="Content2Column"> <!-- Content3Column for index -->
<div id="content">
<h1 class="FirstChild">Object Streams Tutorial</h1>
<p>XStream provides alternative implementations of <code>java.io.ObjectInputStream</code> and
<code>java.io.ObjectOutputStream</code>,
allowing streams of objects to be serialized or deserialized from XML.</p>
<p>This is useful when processing large sets of objects, as only one needs to be in memory
at a time.</p>
<p>Obviously you should use also a stream-based XML parser reading the XML. A DOM-based XML parser
will process the complete XML and build the object model before XStream is able to to handle the first
element.</p>
<!-- ************ -->
<h1 id="using">Using the Object Streams</h1>
<p>The interface to the object streaming capabilities of XStream is through the standard
<code>java.io.ObjectOutputStream</code> and <code>java.io.ObjectInputStream</code> objects.</p>
<h2>Example</h2>
<p>To serialize a stream of objects to XML:</p>
<div class="Source Java"><pre>ObjectOutputStream out = xstream.createObjectOutputStream(someWriter);
out.writeObject(new Person("Joe", "Walnes"));
out.writeObject(new Person("Someone", "Else"));
out.writeObject("hello");
out.writeInt(12345);
out.close();</pre></div>
<p>The resulting XML:</p>
<div class="Source XML"><pre><object-stream>
<com.blah.Person>
<firstname>Joe</firstname>
<lastname>Walnes</lastname>
</com.blah.Person>
<com.blah.Person>
<firstname>Someone</firstname>
<lastname>Else</lastname>
</com.blah.Person>
<string>hello</string>
<int>123</int>
</object-stream></pre></div>
<p>To deserialze the stream of objects from the XML:</p>
<div class="Source Java"><pre>ObjectInputStream in = xstream.createObjectInputStream(someReader);
Person a = (Person)in.readObject();
Person b = (Person)in.readObject();
String c = (String)in.readObject();
int d = in.readInt();</pre></div>
<!-- ************ -->
<h1 id="considerations">Considerations</h1>
<h2>Root node</h2>
<p>Because an XML document can only have a single root node, all the serialized elements must be wrapped in an
additional root node. This root node defaults to <code><object-stream></code>, as shown in the example above.</p>
<p>This can be changed by using the overloaded method:
<code>xstream.createObjectOutputStream(Writer writer, String rootNodeName);</code></p>
<h2>Close the ObjectOutputStream</h2>
<p>Remember to call <code>ObjectOutputStream.close()</code>, otherwise the stream will contain incomplete XML.</p>
<h2>Detecting the end of the ObjectInputStream</h2>
<p>When there are no more objects left to read in the stream, <code>ObjectInputStream.readObject()</code> (or primitive
equivalent) will throw <code>java.io.EOFException</code>.</p>
<h2>References</h2>
<p>Normally XStream will not know about references between the different objects that are written individually in the ObjectStream.
Nevertheless there is an example in the acceptance tests (MultipleObjectsInOneStreamTest) where such a functionality is realized with
the help of a custom MarshallingStrategy. Note, that this implementation is not for general use, since it will ignore some parameters at
second invocation, but they do not matter in the demonstrated use case. Additionally those references prevent the objects from being
garbage collected, which is a bit counter-productive for the use case of ObjectStreams as described above. So you have to know what
you do!</p>
<br/>
</div>
</div>
<div class="SidePanel" id="left">
<div class="MenuGroup">
<h1>Software</h1>
<ul>
<li><a href="index.html">About XStream</a></li>
<li><a href="news.html">News</a></li>
<li><a href="changes.html">Change History</a></li>
<li><a href="security.html">Security Aspects</a></li>
<li><a href="versioning.html">About Versioning</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Evaluating XStream</h1>
<ul>
<li><a href="tutorial.html">Two Minute Tutorial</a></li>
<li><a href="license.html">License</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="references.html">References</a></li>
<li><a href="benchmarks.html">Benchmarks</a></li>
<li><a href="https://www.openhub.net/p/xstream">Code Statistics</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Using XStream</h1>
<ul>
<li><a href="architecture.html">Architecture Overview</a></li>
<li><a href="graphs.html">Object references</a></li>
<li><a href="manual-tweaking-output.html">Tweaking the Output</a></li>
<li><a href="converters.html">Converters</a></li>
<li><a href="faq.html">Frequently Asked Questions</a></li>
<li><a href="mailing-lists.html">Mailing Lists</a></li>
<li><a href="issues.html">Reporting Issues</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Javadoc</h1>
<ul>
<li><a href="javadoc/index.html">XStream Core</a></li>
<li><a href="hibernate-javadoc/index.html">Hibernate Extensions</a></li>
<li><a href="jmh-javadoc/index.html">JMH Module</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Tutorials</h1>
<ul>
<li><a href="tutorial.html">Two Minute Tutorial</a></li>
<li><a href="alias-tutorial.html">Alias Tutorial</a></li>
<li><a href="annotations-tutorial.html">Annotations Tutorial</a></li>
<li><a href="converter-tutorial.html">Converter Tutorial</a></li>
<li class="currentLink">Object Streams Tutorial</li>
<li><a href="persistence-tutorial.html">Persistence API Tutorial</a></li>
<li><a href="json-tutorial.html">JSON Tutorial</a></li>
<li><a href="http://www.studytrails.com/java/xml/xstream/xstream-introduction.jsp">StudyTrails</a></li>
</ul>
</div>
<div class="MenuGroup">
<h1>Developing XStream</h1>
<ul>
<li><a href="how-to-contribute.html">How to Contribute</a></li>
<li><a href="team.html">Development Team</a></li>
<li><a href="repository.html">Source Repository</a></li>
<li><a href="https://travis-ci.org/x-stream/xstream/branches">Continuous Integration</a></li>
</ul>
</div>
</div>
</body>
</html>