1 /**
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements.  See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership.  The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License.  You may obtain a copy of the License at
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 package org.apache.hadoop.record;
20 
21 /**
22  * Interface that acts as an iterator for deserializing maps.
23  * The deserializer returns an instance that the record uses to
24  * read vectors and maps. An example of usage is as follows:
25  *
26  * <code>
27  * Index idx = startVector(...);
28  * while (!idx.done()) {
29  *   .... // read element of a vector
30  *   idx.incr();
31  * }
32  * </code>
33  */
34 public interface Index {
done()35   boolean done();
incr()36   void incr();
37 }
38