This project has retired. For details please refer to its Attic page.
ExtendedDataInput xref
View Javadoc

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  package org.apache.giraph.utils;
19  
20  import java.io.DataInput;
21  
22  /**
23   * Add some functionality to data input
24   */
25  public interface ExtendedDataInput extends DataInput {
26    /**
27     * Get the position of what has been read
28     *
29     * @return How many bytes have been read?
30     */
31    int getPos();
32  
33    /**
34     * How many bytes are available?
35     *
36     * @return Bytes available
37     */
38    int available();
39  
40    /**
41     * Check if we read everything from the input
42     *
43     * @return True iff we read everything from the input
44     */
45    boolean endOfInput();
46  }