apidocs/com/amazon/carbonado/raw/package-summary.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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:44 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>com.amazon.carbonado.raw (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="com.amazon.carbonado.raw (Carbonado 1.2.3 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Prev Package</a></li>
<li><a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/raw/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;com.amazon.carbonado.raw</h1>
<div class="docSummary">
<div class="block">Provides support for repositories that encode/decode storables in a raw
 binary format.</div>
</div>
<p>See:&nbsp;<a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">CustomStorableCodec.InstanceFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">GenericInstanceFactory</a></td>
<td class="colLast">
<div class="block">Can be used with <a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><code>QuickConstructorGenerator</code></a>
 for instantiating generic storable instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></td>
<td class="colLast">
<div class="block">Minimal information required by <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><code>GenericEncodingStrategy</code></a> to encode
 and decode a storable property.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a>&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</td>
<td class="colLast">
<div class="block">Used for decoding different generations of Storable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a>&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</td>
<td class="colLast">
<div class="block">Creates custom raw search keys for <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a>&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</td>
<td class="colLast">
<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><code>RawStorableGenerator</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a>&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</td>
<td class="colLast">
<div class="block">Supports encoding and decoding of storables.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></td>
<td class="colLast">
<div class="block">Factory for creating instances of <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodec</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a>&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</td>
<td class="colLast">
<div class="block">Extension of GenericEncodingStrategy that allows for compression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></td>
<td class="colLast">
<div class="block">Extension of GenericStorableCodecFactory that allows for compression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a>&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</td>
<td class="colLast">
<div class="block">Allows codecs to be defined for storables that have a custom encoding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></td>
<td class="colLast">
<div class="block">Factory for custom storable codecs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></td>
<td class="colLast">
<div class="block">A very low-level class that decodes key components encoded by methods of
 <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw"><code>DataEncoder</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></td>
<td class="colLast">
<div class="block">A very low-level class that supports encoding of primitive data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a>&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</td>
<td class="colLast">
<div class="block">Generates bytecode instructions for encoding/decoding Storable properties
 to/from raw bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a>&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</td>
<td class="colLast">
<div class="block">Generic codec that supports any kind of storable by auto-generating and
 caching storable implementations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></td>
<td class="colLast">
<div class="block">Factory for generic codec that supports any kind of storable by
 auto-generating and caching storable implementations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw">GzipCompressor</a></td>
<td class="colLast">
<div class="block">Raw-level data compression using gzip.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></td>
<td class="colLast">
<div class="block">A very low-level class that decodes key components encoded by methods of
 <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><code>KeyEncoder</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></td>
<td class="colLast">
<div class="block">A very low-level class that supports encoding of primitive data into unique,
 sortable byte array keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a>&lt;S&gt;</td>
<td class="colLast">
<div class="block">Abstract Cursor implementation for a repository that manipulates raw bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">RawStorableGenerator</a></td>
<td class="colLast">
<div class="block">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types
 which are encoded and decoded in a raw format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw">RawUtil</a></td>
<td class="colLast">
<div class="block">Utilities for manipulating binary data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></td>
<td class="colLast">
<div class="block">Available compression types for any particular storable.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!--   -->
</a>
<h2 title="Package com.amazon.carbonado.raw Description">Package com.amazon.carbonado.raw Description</h2>
<div class="block">Provides support for repositories that encode/decode storables in a raw
 binary format.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Prev Package</a></li>
<li><a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/raw/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>