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.edge;
20
21 import org.apache.hadoop.io.Writable;
22 import org.apache.hadoop.io.WritableComparable;
23
24 import java.util.Iterator;
25
26 /**
27 * Interface for {@link OutEdges} implementations that have an optimized
28 * mutable edge iterator.
29 *
30 * @param <I> Vertex id
31 * @param <E> Edge value
32 */
33 public interface MutableOutEdges<I extends WritableComparable,
34 E extends Writable> extends OutEdges<I, E> {
35 /**
36 * Returns an iterator over edges that can be modified in-place,
37 * either by changing the current edge value or by removing the current edge.
38 *
39 * @return A mutable edge iterator
40 */
41 Iterator<MutableEdge<I, E>> mutableIterator();
42 }