IDirectedGraph.java

/*
Copyright 2011-2016 Google Inc. All Rights Reserved.

Licensed 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 com.google.security.zynamics.binnavi.API.disassembly;

import java.util.List;

// ! Interface for directed graphs.
/**
 * Interface that must be implemented by all graph types that want to make use of API graph
 * algorithms.
 *
 * @param <NodeType> Type of the nodes in the graph.
 * @param <EdgeType> Type of the edges in the graph.
 */
@SuppressWarnings("hiding")
public interface IDirectedGraph<NodeType, EdgeType>
    extends com.google.security.zynamics.zylib.types.graphs.IDirectedGraph<NodeType, EdgeType> {
  // ! Number of edges in the graph.
  /**
   * Returns the number of edges in the graph.
   *
   * @return The number of edges in the graph.
   */
  @Override
  int edgeCount();

  // ! Edges of the graph.
  /**
   * Returns the edges of the graph.
   *
   * @return The edges of the graph.
   */
  @Override
  List<EdgeType> getEdges();

  // ! Nodes of the graph.
  /**
   * Returns the nodes of the graph.
   *
   * @return The nodes of the graph.
   */
  @Override
  List<NodeType> getNodes();

  // ! Number of nodes in the graph.
  /**
   * Returns the number of nodes in the graph.
   *
   * @return The number of nodes in the graph.
   */
  @Override
  int nodeCount();
}