Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
VertexIdEdgeIterator |
|
| 1.0;1 |
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.giraph.utils; | |
20 | ||
21 | import org.apache.giraph.edge.Edge; | |
22 | import org.apache.hadoop.io.Writable; | |
23 | import org.apache.hadoop.io.WritableComparable; | |
24 | ||
25 | /** | |
26 | * Special iterator that reuses vertex ids and edge objects so that the | |
27 | * lifetime of the object is only until next() is called. | |
28 | * | |
29 | * @param <I> vertexId type parameter | |
30 | * @param <E> edge type parameter | |
31 | */ | |
32 | public interface VertexIdEdgeIterator<I extends WritableComparable, | |
33 | E extends Writable> extends VertexIdDataIterator<I, Edge<I, E>> { | |
34 | /** | |
35 | * Get the current edge. | |
36 | * | |
37 | * @return Current edge | |
38 | */ | |
39 | Edge<I, E> getCurrentEdge(); | |
40 | ||
41 | /** | |
42 | * Release the current edge. | |
43 | * | |
44 | * @return Released edge | |
45 | */ | |
46 | Edge<I, E> releaseCurrentEdge(); | |
47 | } |