org.jgrapht.ext.VertexNameProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jgrapht-ext Show documentation

There is a newer version: 1.5.2

/* ==========================================
 * JGraphT : a free Java graph-theory library
 * ==========================================
 *
 * Project Info:  http://jgrapht.sourceforge.net/
 * Project Creator:  Barak Naveh (http://sourceforge.net/users/barak_naveh)
 *
 * (C) Copyright 2003-2008, by Barak Naveh and Contributors.
 *
 * 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.
 */
/* ------------------
 * VertexNameProvider.java
 * ------------------
 * (C) Copyright 2005-2008, by Avner Linder and Contributors.
 *
 * Original Author:  Avner Linder
 *
 * $Id$
 *
 * Changes
 * -------
 * 27-May-2004 : Initial Version (AL);
 * 13-Dec-2005 : Split out of VisioExporter (CF);
 *
 */
package org.jgrapht.ext;

/**
 * Assigns a display name for each of the graph vertices.
 */
public interface VertexNameProvider
{
    /**
     * Returns a unique name for a vertex. This is useful when exporting a a
     * graph, as it ensures that all vertices are assigned simple, consistent
     * names.
     *
     * @param vertex the vertex to be named
     *
     * @return the name of the vertex
     */
    public String getVertexName(V vertex);
}

// End VertexNameProvider.java