-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
BinaryReader.java
289 lines (252 loc) · 9.39 KB
/
BinaryReader.java
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
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.ignite.binary;
import java.math.BigDecimal;
import java.sql.Timestamp;
import java.util.Collection;
import java.util.Date;
import java.util.Map;
import java.util.UUID;
/**
* Reader for portable objects used in {@link Binarylizable} implementations.
* Useful for the cases when user wants a fine-grained control over serialization.
* <p>
* Note that Ignite never writes full strings for field or type names. Instead,
* for performance reasons, Ignite writes integer hash codes for type and field names.
* It has been tested that hash code conflicts for the type names or the field names
* within the same type are virtually non-existent and, to gain performance, it is safe
* to work with hash codes. For the cases when hash codes for different types or fields
* actually do collide, Ignite provides {@link BinaryIdMapper} which
* allows to override the automatically generated hash code IDs for the type and field names.
*/
public interface BinaryReader {
/**
* @param fieldName Field name.
* @return Byte value.
* @throws BinaryObjectException In case of error.
*/
public byte readByte(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Short value.
* @throws BinaryObjectException In case of error.
*/
public short readShort(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Integer value.
* @throws BinaryObjectException In case of error.
*/
public int readInt(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Long value.
* @throws BinaryObjectException In case of error.
*/
public long readLong(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @throws BinaryObjectException In case of error.
* @return Float value.
*/
public float readFloat(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Double value.
* @throws BinaryObjectException In case of error.
*/
public double readDouble(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Char value.
* @throws BinaryObjectException In case of error.
*/
public char readChar(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Boolean value.
* @throws BinaryObjectException In case of error.
*/
public boolean readBoolean(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Decimal value.
* @throws BinaryObjectException In case of error.
*/
public BigDecimal readDecimal(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return String value.
* @throws BinaryObjectException In case of error.
*/
public String readString(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return UUID.
* @throws BinaryObjectException In case of error.
*/
public UUID readUuid(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Date.
* @throws BinaryObjectException In case of error.
*/
public Date readDate(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Timestamp.
* @throws BinaryObjectException In case of error.
*/
public Timestamp readTimestamp(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Object.
* @throws BinaryObjectException In case of error.
*/
public <T> T readObject(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Byte array.
* @throws BinaryObjectException In case of error.
*/
public byte[] readByteArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Short array.
* @throws BinaryObjectException In case of error.
*/
public short[] readShortArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Integer array.
* @throws BinaryObjectException In case of error.
*/
public int[] readIntArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Long array.
* @throws BinaryObjectException In case of error.
*/
public long[] readLongArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Float array.
* @throws BinaryObjectException In case of error.
*/
public float[] readFloatArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Byte array.
* @throws BinaryObjectException In case of error.
*/
public double[] readDoubleArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Char array.
* @throws BinaryObjectException In case of error.
*/
public char[] readCharArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Boolean array.
* @throws BinaryObjectException In case of error.
*/
public boolean[] readBooleanArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Decimal array.
* @throws BinaryObjectException In case of error.
*/
public BigDecimal[] readDecimalArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return String array.
* @throws BinaryObjectException In case of error.
*/
public String[] readStringArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return UUID array.
* @throws BinaryObjectException In case of error.
*/
public UUID[] readUuidArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Date array.
* @throws BinaryObjectException In case of error.
*/
public Date[] readDateArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Timestamp array.
* @throws BinaryObjectException In case of error.
*/
public Timestamp[] readTimestampArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Object array.
* @throws BinaryObjectException In case of error.
*/
public Object[] readObjectArray(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Collection.
* @throws BinaryObjectException In case of error.
*/
public <T> Collection<T> readCollection(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @param factory Collection factory.
* @return Collection.
* @throws BinaryObjectException In case of error.
*/
public <T> Collection<T> readCollection(String fieldName, BinaryCollectionFactory<T> factory)
throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Map.
* @throws BinaryObjectException In case of error.
*/
public <K, V> Map<K, V> readMap(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @param factory Map factory.
* @return Map.
* @throws BinaryObjectException In case of error.
*/
public <K, V> Map<K, V> readMap(String fieldName, BinaryMapFactory<K, V> factory) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Value.
* @throws BinaryObjectException In case of error.
*/
public <T extends Enum<?>> T readEnum(String fieldName) throws BinaryObjectException;
/**
* @param fieldName Field name.
* @return Value.
* @throws BinaryObjectException In case of error.
*/
public <T extends Enum<?>> T[] readEnumArray(String fieldName) throws BinaryObjectException;
/**
* Gets raw reader. Raw reader does not use field name hash codes, therefore,
* making the format even more compact. However, if the raw reader is used,
* dynamic structure changes to the binary objects are not supported.
*
* @return Raw reader.
*/
public BinaryRawReader rawReader();
}