org.jgrapht.graph.GraphPathImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgrapht-core Show documentation
There is a newer version: 1.5.2
/*
 * (C) Copyright 2009-2016, by John V Sichi and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * This program and the accompanying materials are dual-licensed under
 * either
 *
 * (a) the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation, or (at your option) any
 * later version.
 *
 * or (per the licensee's choosing)
 *
 * (b) the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation.
 */
package org.jgrapht.graph;

import java.util.*;

import org.jgrapht.*;

/**
 * GraphPathImpl is a default implementation of {@link GraphPath}.
 *
 * @author John Sichi
 * @version $Id$
 *
 * @param  the graph vertex type
 * @param  the graph edge type
 *
 * @deprecated use {@link GraphWalk} instead
 */
@Deprecated
public class GraphPathImpl
    implements GraphPath
{
    private Graph graph;

    private List edgeList;

    private V startVertex;

    private V endVertex;

    private double weight;

    /**
     * Create a new graph path
     * 
     * @param graph the graph
     * @param startVertex the start vertex
     * @param endVertex the end vertex
     * @param edgeList the edge list of the path
     * @param weight the total weight of the path
     */
    public GraphPathImpl(
        Graph graph, V startVertex, V endVertex, List edgeList, double weight)
    {
        this.graph = graph;
        this.startVertex = startVertex;
        this.endVertex = endVertex;
        this.edgeList = edgeList;
        this.weight = weight;
    }

    // implement GraphPath
    @Override
    public Graph getGraph()
    {
        return graph;
    }

    // implement GraphPath
    @Override
    public V getStartVertex()
    {
        return startVertex;
    }

    // implement GraphPath
    @Override
    public V getEndVertex()
    {
        return endVertex;
    }

    // implement GraphPath
    @Override
    public List getEdgeList()
    {
        return edgeList;
    }

    // implement GraphPath
    @Override
    public double getWeight()
    {
        return weight;
    }

    // override Object
    @Override
    public String toString()
    {
        return edgeList.toString();
    }
}

// End GraphPathImpl.java