com.ibm.wala.util.graph.NodeManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.ibm.wala.util Show documentation

T. J. Watson Libraries for Analysis

The newest version!

/*
 * Copyright (c) 2002 - 2006 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 */
package com.ibm.wala.util.graph;

import java.util.Collection;
import java.util.Iterator;
import java.util.stream.Stream;
import org.jspecify.annotations.Nullable;

/**
 * An object which tracks graph nodes.
 *
 * This is effectively a stripped-down collection interface. We choose to avoid using the full
 * {@link Collection} interface, so that it takes less code to implement a new {@link NodeManager}.
 *
 * @param  the type of nodes this {@link NodeManager} tracks.
 */
public interface NodeManager extends Iterable {

  /**
   * @return an {@link Iterator} of the nodes in this graph
   */
  @Override
  default Iterator iterator() {
    return stream().iterator();
  }

  /**
   * @return a {@link Stream} of the nodes in this graph
   */
  Stream stream();

  /**
   * @return the number of nodes in this graph
   */
  int getNumberOfNodes();

  /** add a node to this graph */
  void addNode(T n);

  /** remove a node from this graph */
  void removeNode(T n) throws UnsupportedOperationException;

  /**
   * @return true iff the graph contains the specified node
   */
  boolean containsNode(@Nullable T n);
}