All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jgrapht.nio.GraphExporter Maven / Gradle / Ivy

The newest version!
/*
 * (C) Copyright 2016-2023, by Dimitrios Michail and Contributors.
 *
 * JGraphT : a free Java graph-theory library
 *
 * See the CONTRIBUTORS.md file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the
 * GNU Lesser General Public License v2.1 or later
 * which is available at
 * http://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR LGPL-2.1-or-later
 */
package org.jgrapht.nio;

import org.jgrapht.*;

import java.io.*;
import java.nio.charset.*;

/**
 * Interface for graph exporters
 * 
 * @param  the graph vertex type
 * @param  the graph edge type
 */
public interface GraphExporter
{

    /**
     * Export a graph to the given {@link OutputStream}.
     * 

* It is the callers responsibility to ensure the {@code OutputStream} is closed after this * method returned. *

* * @param g the graph to export * @param out the output stream * @throws ExportException in case any error occurs */ default void exportGraph(Graph g, OutputStream out) { exportGraph(g, new OutputStreamWriter(out, StandardCharsets.UTF_8)); } /** * Export a graph using the given {@link Writer}. *

* It is the callers responsibility to ensure the {@code Writer} is closed after this method * returned. *

* * @param g the graph to export * @param writer the output writer * @throws ExportException in case any error occurs */ void exportGraph(Graph g, Writer writer); /** * Export a graph to the given {@link File}. * * @param g the graph to export * @param file the file to write to * @throws ExportException in case any error occurs */ default void exportGraph(Graph g, File file) { try (Writer writer = new FileWriter(file, StandardCharsets.UTF_8)) { exportGraph(g, writer); } catch (IOException e) { throw new ExportException(e); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy