org.dishevelled.bio.alignment.sam.SamCommentHeaderLine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dsh-bio-alignment Show documentation
Alignments.
There is a newer version: 2.4
/*

    dsh-bio-alignment  Aligments.
    Copyright (c) 2013-2019 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.alignment.sam;

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

import static org.dishevelled.bio.alignment.sam.SamHeaderParser.parseFields;

import java.util.Map;

import javax.annotation.concurrent.Immutable;

/**
 * SAM comment header line.
 *
 * @since 1.1
 * @author  Michael Heuer
 */
@Immutable
public final class SamCommentHeaderLine extends AbstractSamHeaderLine {

    /**
     * Create a new SAM comment header line.
     *
     * @param fields field values keyed by tag, must not be null
     */
    private SamCommentHeaderLine(final Map fields) {
        super("CO", fields);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("@");
        sb.append(getTag());

        for (Map.Entry entry : getFields().entrySet()) {
            sb.append("\t");
            sb.append(entry.getKey());
            sb.append(":");
            sb.append(entry.getValue());
        }
        return sb.toString();
    }

    /**
     * Parse the specified value into a SAM comment header line.
     *
     * @param value value, must not be null
     * @return the specified value parsed into a SAM comment header line
     */
    public static SamCommentHeaderLine valueOf(final String value) {
        checkNotNull(value);
        checkArgument(value.startsWith("@CO"));

        Map fields = parseFields(value.replace("@CO", "").trim());
        return new SamCommentHeaderLine(fields);
    }
}