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 /**
25 * A complete edge, the target vertex and the edge value. Can only be one
26 * edge with a destination vertex id per edge map. This edge can be reused,
27 * that is you can set it's target vertex ID and edge value.
28 * Note: this class is useful for certain optimizations,
29 * but it's not meant to be exposed to the user. Look at {@link MutableEdge}
30 * instead.
31 *
32 * @param <I> Vertex index
33 * @param <E> Edge value
34 */
35 public interface ReusableEdge<I extends WritableComparable, E extends Writable>
36 extends MutableEdge<I, E> {
37 /**
38 * Set the destination vertex index of this edge.
39 *
40 * @param targetVertexId new destination vertex
41 */
42 void setTargetVertexId(I targetVertexId);
43 }