| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.apache.giraph.utils; |
| |
| import org.apache.hadoop.io.Writable; |
| import org.apache.hadoop.io.WritableComparable; |
| |
| /** |
| * Special iterator that reuses vertex ids and message objects so that the |
| * lifetime of the object is only until next() is called. |
| * |
| * @param <I> vertexId type parameter |
| * @param <M> message type parameter |
| */ |
| public interface VertexIdMessageIterator<I extends WritableComparable, |
| M extends Writable> extends VertexIdDataIterator<I, M> { |
| /** |
| * Get the current message. |
| * |
| * @return Current message |
| */ |
| M getCurrentMessage(); |
| |
| /** |
| * Get the serialized size of current message |
| * |
| * @return serialized size of current message |
| */ |
| int getCurrentMessageSize(); |
| |
| /** |
| * Return true of current message is new |
| * |
| * @return true if current message is new |
| */ |
| boolean isNewMessage(); |
| } |