org.dishevelled.bio.assembly.gfa2.Header.java Source code

Introduction

Here is the source code for org.dishevelled.bio.assembly.gfa2.Header.java

Source

/*
    
dsh-bio-assembly  Assemblies.
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.assembly.gfa2;

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

import java.util.List;
import java.util.Map;

import javax.annotation.concurrent.Immutable;

import com.google.common.base.Joiner;
import com.google.common.base.Splitter;

import com.google.common.collect.ImmutableMap;

import org.dishevelled.bio.assembly.gfa.Tag;

/**
 * Header GFA 2.0 record.
 *
 * @author  Michael Heuer
 */
@Immutable
public final class Header extends Gfa2Record {

    /**
     * Create a new header GFA 2.0 record.
     *
     * @param tags tags, must not be null
     */
    public Header(final Map<String, Tag> tags) {
        super(tags);
    }

    @Override
    public int hashCode() {
        return getTags().hashCode();
    }

    @Override
    public boolean equals(final Object o) {
        if (o == this) {
            return true;
        }
        if (!(o instanceof Header)) {
            return false;
        }
        Header h = (Header) o;

        return getTags().equals(h.getTags());
    }

    @Override
    public String toString() {
        Joiner joiner = Joiner.on("\t");
        StringBuilder sb = new StringBuilder();
        sb.append("H");
        if (!getTags().isEmpty()) {
            sb.append("\t");
            joiner.appendTo(sb, getTags().values());
        }
        return sb.toString();
    }

    /**
     * Parse a header GFA 2.0 record from the specified value.
     *
     * @param value value, must not be null
     * @return a header GFA 2.0 record parsed from the specified value
     */
    public static Header valueOf(final String value) {
        checkNotNull(value);
        checkArgument(value.startsWith("H"), "header value must start with H");
        List<String> tokens = Splitter.on("\t").splitToList(value);
        ImmutableMap.Builder<String, Tag> tags = ImmutableMap.builder();
        for (int i = 1; i < tokens.size(); i++) {
            Tag tag = Tag.valueOf(tokens.get(i));
            tags.put(tag.getName(), tag);
        }

        return new Header(tags.build());
    }
}