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.hadoop.io.Writable;
22 import org.apache.hadoop.io.WritableComparable;
23
24 /**
25 * VertexIdMessages
26 *
27 * @param <I> vertexId type parameter
28 * @param <M> message type parameter
29 */
30 public interface VertexIdMessages<I extends WritableComparable,
31 M extends Writable> extends VertexIdData<I, M> {
32 /**
33 * Get specialized iterator that will instantiate the vertex id and
34 * message of this object. It will only produce message bytes, not actual
35 * messages and expects a different encoding.
36 *
37 * @return Special iterator that reuses vertex ids (unless released) and
38 * copies message bytes
39 */
40 VertexIdMessageBytesIterator<I, M> getVertexIdMessageBytesIterator();
41
42 /**
43 * Get specialized iterator that will instiantiate the vertex id and
44 * message of this object.
45 *
46 * @return Special iterator that reuses vertex ids and messages unless
47 * specified
48 */
49 VertexIdMessageIterator<I, M> getVertexIdMessageIterator();
50 }