org.dishevelled.bio.assembly.gfa2.Gfa2Writer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dsh-bio-assembly Show documentation
Assemblies.
The newest version!
/*

    dsh-bio-assembly  Assemblies.
    Copyright (c) 2013-2024 held jointly by the individual authors.

    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 3 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; with out 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

    > http://www.fsf.org/licensing/licenses/lgpl.html
    > http://www.opensource.org/licenses/lgpl-license.php

*/
package org.dishevelled.bio.assembly.gfa2;

import static com.google.common.base.Preconditions.checkNotNull;

import java.io.PrintWriter;

import javax.annotation.concurrent.Immutable;

/**
 * Graphical Fragment Assembly (GFA) 2.0 writer.
 *
 * @author  Michael Heuer
 */
@Immutable
public final class Gfa2Writer {

    /**
     * Private no-arg constructor.
     */
    private Gfa2Writer() {
        // empty
    }


    /**
     * Write the specified GFA 2.0 record with the specified print writer.
     *
     * @param record GFA 2.0 record to write, must not be null
     * @param writer print writer to write GFA 2.0 record with, must not be null
     */
    public static void write(final Gfa2Record record, final PrintWriter writer) {
        checkNotNull(record);
        checkNotNull(writer);
        writer.println(record.toString());
    }

    /**
     * Write zero or more GFA 2.0 records with the specified print writer.
     *
     * @param records zero or more GFA 2.0 records to write, must not be null
     * @param writer print writer to write GFA 2.0 records with, must not be null
     */
    public static void write(final Iterable records, final PrintWriter writer) {
        checkNotNull(records);
        checkNotNull(writer);
        for (Gfa2Record record : records) {
            writer.println(record.toString());
        }
    }
}