giraph-core/src/main/java/org/apache/giraph/edge/MutableOutEdges.java

/*
 * 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.edge;

import org.apache.hadoop.io.Writable;
import org.apache.hadoop.io.WritableComparable;

import java.util.Iterator;

/**
 * Interface for {@link OutEdges} implementations that have an optimized
 * mutable edge iterator.
 *
 * @param <I> Vertex id
 * @param <E> Edge value
 */
public interface MutableOutEdges<I extends WritableComparable,
    E extends Writable> extends OutEdges<I, E> {
  /**
   * Returns an iterator over edges that can be modified in-place,
   * either by changing the current edge value or by removing the current edge.
   *
   * @return A mutable edge iterator
   */
  Iterator<MutableEdge<I, E>> mutableIterator();
}