org.broadinstitute.hellbender.tools.copynumber.gcnv.IntegerCopyNumberState Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gatk Show documentation

Development on GATK 4

There is a newer version: 4.6.0.0

package org.broadinstitute.hellbender.tools.copynumber.gcnv;

import org.broadinstitute.hellbender.utils.param.ParamUtils;

import javax.annotation.Nonnull;

/**
 * This class represents integer copy number states.
 *
 * @author Mehrtash Babadi <[email protected]>
 */
public final class IntegerCopyNumberState implements Comparable {
    /**
     * Integer value of the represented copy number state
     */
    private final int copyNumber;

    public IntegerCopyNumberState(final int copyNumber) {
        this.copyNumber = ParamUtils.isPositiveOrZero(copyNumber, "The integer copy number state" +
                " must be non-negative.");
    }

    public int getCopyNumber() { return copyNumber; }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        return copyNumber == ((IntegerCopyNumberState) o).copyNumber;
    }

    @Override
    public int compareTo(@Nonnull final IntegerCopyNumberState other) {
        return copyNumber - other.copyNumber;
    }

    @Override
    public int hashCode() {
        return copyNumber;
    }

    @Override
    public String toString() {
        return GermlineCNVNamingConstants.COPY_NUMBER_TABLE_COLUMN_PREFIX + Integer.toString(copyNumber);
    }
}