001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package org.apache.hadoop.record;
020    
021    import org.apache.hadoop.classification.InterfaceAudience;
022    import org.apache.hadoop.classification.InterfaceStability;
023    
024    /**
025     * Interface that acts as an iterator for deserializing maps.
026     * The deserializer returns an instance that the record uses to
027     * read vectors and maps. An example of usage is as follows:
028     *
029     * <code>
030     * Index idx = startVector(...);
031     * while (!idx.done()) {
032     *   .... // read element of a vector
033     *   idx.incr();
034     * }
035     * </code>
036     * 
037     * @deprecated Replaced by <a href="https://hadoop.apache.org/avro/">Avro</a>.
038     */
039    @Deprecated
040    @InterfaceAudience.Public
041    @InterfaceStability.Stable
042    public interface Index {
043      boolean done();
044      void incr();
045    }