StringDumper.java

/**
 * Copyright (C) 2013-2014 Olaf Lessenich
 * Copyright (C) 2014-2015 University of Passau, Germany
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 *
 * Contributors:
 *     Olaf Lessenich <lessenic@fim.uni-passau.de>
 *     Georg Seibt <seibt@fim.uni-passau.de>
 */
package de.fosd.jdime.strdump;

import java.util.function.Function;

import de.fosd.jdime.artifact.Artifact;

/**
 * Implementations of this class dump <code>Artifact</code> (trees) to a <code>String</code>.
 */
public interface StringDumper {

    /**
     * Dumps the given <code>artifact</code> to a <code>String</code>.
     *
     * @param artifact
     *         the artifact to dump
     * @param getLabel
     *         the function to use for producing labels for artifacts
     * @param <T>
     *         the type of the artifact
     * @return the <code>String</code> representation
     */
    <T extends Artifact<T>> String dump(Artifact<T> artifact, Function<Artifact<T>, String> getLabel);
}