io.repseq.core

Class VDJCLibraryId

java.lang.Object

io.repseq.core.VDJCLibraryId

All Implemented Interfaces:

Comparable<VDJCLibraryId>

public final class VDJCLibraryId
extends Object
implements Comparable<VDJCLibraryId>

Taxon id and library name and optional library checksum

Constructor Summary

Constructors

Constructor and Description
VDJCLibraryId(String libraryName, long taxonId) Creates VDJCLibraryId from taxonId and library name
VDJCLibraryId(String libraryName, long taxonId, byte[] checksum) Creates VDJCLibraryId from taxonId, library name and checksum

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(VDJCLibraryId o)
static VDJCLibraryId	decode(String str) Return VDJCLibraryId object from string representation returned by toString().
boolean	equals(Object o)
byte[]	getChecksum() Return checksum
String	getLibraryName() Library name
long	getTaxonId() Taxon id
int	hashCode()
boolean	requireChecksumCheck() Returns whether this id also contain checksum information
VDJCLibraryId	setLibraryName(String newLibraryName) Return new instance of VDJCLibraryId with different library name
String	toString()
VDJCLibraryId	withoutChecksum() Returns copy of this VDJCLibraryId with checksum set to null

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VDJCLibraryId

public VDJCLibraryId(String libraryName,
             long taxonId)

Creates VDJCLibraryId from taxonId and library name

Parameters:

libraryName - library name

taxonId - taxon id

VDJCLibraryId

public VDJCLibraryId(String libraryName,
             long taxonId,
             byte[] checksum)

Creates VDJCLibraryId from taxonId, library name and checksum

Parameters:

libraryName - library name

taxonId - taxon id

checksum - checksum

Method Detail

getTaxonId

public long getTaxonId()

Taxon id

Returns:

taxon id

getLibraryName

public String getLibraryName()

Library name

Returns:

library name

getChecksum

public byte[] getChecksum()

Return checksum

Returns:

checksum

withoutChecksum

public VDJCLibraryId withoutChecksum()

Returns copy of this VDJCLibraryId with checksum set to null

Returns:

copy of this VDJCLibraryId with checksum set to null

requireChecksumCheck

public boolean requireChecksumCheck()

Returns whether this id also contain checksum information

Returns:

whether this id also contain checksum information

setLibraryName

public VDJCLibraryId setLibraryName(String newLibraryName)

Return new instance of VDJCLibraryId with different library name

Parameters:

newLibraryName - new library name

Returns:

new instance of VDJCLibraryId with different library name

compareTo

public int compareTo(VDJCLibraryId o)

Specified by:

compareTo in interface Comparable<VDJCLibraryId>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

decode

public static VDJCLibraryId decode(String str)

Return VDJCLibraryId object from string representation returned by toString(). Format: libraryName:taxonId[:checksum]

Parameters:

str - string representation

Returns:

VDJCLibraryId object

Throws:

IllegalArgumentException - if string has wrong format