annotate src/main/java/org/msgpack/unpacker/Unpacker.java @ 0:cb825acd883a

first commit
author sugi
date Sat, 18 Oct 2014 15:06:15 +0900
parents
children e7e55c455e39
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cb825acd883a first commit
sugi
parents:
diff changeset
1 //
cb825acd883a first commit
sugi
parents:
diff changeset
2 // MessagePack for Java
cb825acd883a first commit
sugi
parents:
diff changeset
3 //
cb825acd883a first commit
sugi
parents:
diff changeset
4 // Copyright (C) 2009 - 2013 FURUHASHI Sadayuki
cb825acd883a first commit
sugi
parents:
diff changeset
5 //
cb825acd883a first commit
sugi
parents:
diff changeset
6 // Licensed under the Apache License, Version 2.0 (the "License");
cb825acd883a first commit
sugi
parents:
diff changeset
7 // you may not use this file except in compliance with the License.
cb825acd883a first commit
sugi
parents:
diff changeset
8 // You may obtain a copy of the License at
cb825acd883a first commit
sugi
parents:
diff changeset
9 //
cb825acd883a first commit
sugi
parents:
diff changeset
10 // http://www.apache.org/licenses/LICENSE-2.0
cb825acd883a first commit
sugi
parents:
diff changeset
11 //
cb825acd883a first commit
sugi
parents:
diff changeset
12 // Unless required by applicable law or agreed to in writing, software
cb825acd883a first commit
sugi
parents:
diff changeset
13 // distributed under the License is distributed on an "AS IS" BASIS,
cb825acd883a first commit
sugi
parents:
diff changeset
14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
cb825acd883a first commit
sugi
parents:
diff changeset
15 // See the License for the specific language governing permissions and
cb825acd883a first commit
sugi
parents:
diff changeset
16 // limitations under the License.
cb825acd883a first commit
sugi
parents:
diff changeset
17 //
cb825acd883a first commit
sugi
parents:
diff changeset
18 package org.msgpack.unpacker;
cb825acd883a first commit
sugi
parents:
diff changeset
19
cb825acd883a first commit
sugi
parents:
diff changeset
20 import java.io.IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
21 import java.io.Closeable;
cb825acd883a first commit
sugi
parents:
diff changeset
22 import java.nio.ByteBuffer;
cb825acd883a first commit
sugi
parents:
diff changeset
23 import java.math.BigInteger;
cb825acd883a first commit
sugi
parents:
diff changeset
24 import java.lang.Iterable;
cb825acd883a first commit
sugi
parents:
diff changeset
25
cb825acd883a first commit
sugi
parents:
diff changeset
26 import org.msgpack.template.Template;
cb825acd883a first commit
sugi
parents:
diff changeset
27 import org.msgpack.type.Value;
cb825acd883a first commit
sugi
parents:
diff changeset
28 import org.msgpack.type.ValueType;
cb825acd883a first commit
sugi
parents:
diff changeset
29
cb825acd883a first commit
sugi
parents:
diff changeset
30 /**
cb825acd883a first commit
sugi
parents:
diff changeset
31 * Standard deserializer.
cb825acd883a first commit
sugi
parents:
diff changeset
32 *
cb825acd883a first commit
sugi
parents:
diff changeset
33 * @version 0.6.0
cb825acd883a first commit
sugi
parents:
diff changeset
34 */
cb825acd883a first commit
sugi
parents:
diff changeset
35 public interface Unpacker extends Iterable<Value>, Closeable {
cb825acd883a first commit
sugi
parents:
diff changeset
36 public <T> T read(Class<T> klass) throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
37
cb825acd883a first commit
sugi
parents:
diff changeset
38 public <T> T read(T to) throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
39
cb825acd883a first commit
sugi
parents:
diff changeset
40 public <T> T read(Template<T> tmpl) throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
41
cb825acd883a first commit
sugi
parents:
diff changeset
42 public <T> T read(T to, Template<T> tmpl) throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
43
cb825acd883a first commit
sugi
parents:
diff changeset
44 public void skip() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
45
cb825acd883a first commit
sugi
parents:
diff changeset
46 public int readArrayBegin() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
47
cb825acd883a first commit
sugi
parents:
diff changeset
48 public void readArrayEnd(boolean check) throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
49
cb825acd883a first commit
sugi
parents:
diff changeset
50 public void readArrayEnd() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
51
cb825acd883a first commit
sugi
parents:
diff changeset
52 public int readMapBegin() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
53
cb825acd883a first commit
sugi
parents:
diff changeset
54 public void readMapEnd(boolean check) throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
55
cb825acd883a first commit
sugi
parents:
diff changeset
56 public void readMapEnd() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
57
cb825acd883a first commit
sugi
parents:
diff changeset
58 public void readNil() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
59
cb825acd883a first commit
sugi
parents:
diff changeset
60 public boolean trySkipNil() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
61
cb825acd883a first commit
sugi
parents:
diff changeset
62 public boolean readBoolean() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
63
cb825acd883a first commit
sugi
parents:
diff changeset
64 public byte readByte() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
65
cb825acd883a first commit
sugi
parents:
diff changeset
66 public short readShort() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
67
cb825acd883a first commit
sugi
parents:
diff changeset
68 public int readInt() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
69
cb825acd883a first commit
sugi
parents:
diff changeset
70 public long readLong() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
71
cb825acd883a first commit
sugi
parents:
diff changeset
72 public BigInteger readBigInteger() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
73
cb825acd883a first commit
sugi
parents:
diff changeset
74 public float readFloat() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
75
cb825acd883a first commit
sugi
parents:
diff changeset
76 public double readDouble() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
77
cb825acd883a first commit
sugi
parents:
diff changeset
78 public byte[] readByteArray() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
79
cb825acd883a first commit
sugi
parents:
diff changeset
80 public ByteBuffer readByteBuffer() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
81
cb825acd883a first commit
sugi
parents:
diff changeset
82 public String readString() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
83
cb825acd883a first commit
sugi
parents:
diff changeset
84 public Value readValue() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
85
cb825acd883a first commit
sugi
parents:
diff changeset
86 public ValueType getNextType() throws IOException;
cb825acd883a first commit
sugi
parents:
diff changeset
87
cb825acd883a first commit
sugi
parents:
diff changeset
88 public UnpackerIterator iterator();
cb825acd883a first commit
sugi
parents:
diff changeset
89
cb825acd883a first commit
sugi
parents:
diff changeset
90 public int getReadByteCount();
cb825acd883a first commit
sugi
parents:
diff changeset
91
cb825acd883a first commit
sugi
parents:
diff changeset
92 public void resetReadByteCount();
cb825acd883a first commit
sugi
parents:
diff changeset
93
cb825acd883a first commit
sugi
parents:
diff changeset
94 public void setRawSizeLimit(int size);
cb825acd883a first commit
sugi
parents:
diff changeset
95
cb825acd883a first commit
sugi
parents:
diff changeset
96 public void setArraySizeLimit(int size);
cb825acd883a first commit
sugi
parents:
diff changeset
97
cb825acd883a first commit
sugi
parents:
diff changeset
98 public void setMapSizeLimit(int size);
cb825acd883a first commit
sugi
parents:
diff changeset
99 }