edu.pitt.dbmi.data.reader.metadata.MetadataWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of data-reader Show documentation

The newest version!

/*
 * Copyright (C) 2018 University of Pittsburgh.
 *
 * 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
 */
package edu.pitt.dbmi.data.reader.metadata;

import com.fasterxml.jackson.core.JsonProcessingException;

import java.io.IOException;
import java.nio.file.Path;

/**
 * Dec 18, 2018 2:39:39 PM
 *
 * @author Kevin V. Bui ([email protected])
 * @version $Id: $Id
 */
public interface MetadataWriter {

    /**
     * Writes the metadata as a string.
     *
     * @param metadata The metadata.
     * @return the metadata as a string.
     * @throws com.fasterxml.jackson.core.JsonProcessingException if an error occurs while processing the JSON.
     */
    String writeAsString(Metadata metadata) throws JsonProcessingException;

    /**
     * Writes the metadata to the output file.
     *
     * @param metadata   The metadata.
     * @param outputFile The output file.
     * @throws java.io.IOException if an error occurs while writing the metadata.
     */
    void write(Metadata metadata, Path outputFile) throws IOException;

}