org.broadinstitute.hellbender.utils.nio

Class NioFileCopierWithProgressMeterResults

java.lang.Object

org.broadinstitute.hellbender.utils.nio.NioFileCopierWithProgressMeterResults

public class NioFileCopierWithProgressMeterResults
extends java.lang.Object

An object to hold the results of a copy operation performed by NioFileCopierWithProgressMeterResults. Designed to be a simple data object that holds information, not to be instantiated by a user directly. Created by jonn on 9/4/18.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChecksum() Get the checksum calculated against dest.
java.lang.String	getChecksumAlgorithm() Get the checksum algorithm used to calculate the checksum of the downloaded file.
java.nio.file.Path	getDestination()
java.lang.String	getExpectedChecksum() Get the expected checksum value for dest as set by the user in NioFileCopierWithProgressMeter.setChecksumAlgorithmAndExpectedChecksum(String, String).
long	getSize()
java.nio.file.Path	getSource()
boolean	isDestFileValid() Returns whether the downloaded file is valid by comparing the checksum and expectedChecksum values.
boolean	wasValidationRequested() Get whether a user requested that a checksum be calculated on the downloaded file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSource

public java.nio.file.Path getSource()

Returns:

The Path of the source file to copy.

getDestination

public java.nio.file.Path getDestination()

Returns:

The Path to the resulting destination of the file after copy.

getSize

public long getSize()

Returns:

The size of the file downloaded.

wasValidationRequested

public boolean wasValidationRequested()

Get whether a user requested that a checksum be calculated on the downloaded file.

Returns:

true iff a checksum was calculated by during the transfer of the file. false otherwise.

getChecksum

public java.lang.String getChecksum()

Get the checksum calculated against dest. If no checksum has been calculated, will return an empty String.

Returns:

The last checksum calculated against dest.

getChecksumAlgorithm

public java.lang.String getChecksumAlgorithm()

Get the checksum algorithm used to calculate the checksum of the downloaded file. If no checksum algorithm was used, will return an empty String.

Returns:

The checksum algorithm used to calculate the checksum of the downloaded file.

getExpectedChecksum

public java.lang.String getExpectedChecksum()

Get the expected checksum value for dest as set by the user in NioFileCopierWithProgressMeter.setChecksumAlgorithmAndExpectedChecksum(String, String). If no checksum has been set, will return an empty String.

Returns:

The expected checksum for dest provided by the user in NioFileCopierWithProgressMeter.setChecksumAlgorithmAndExpectedChecksum(String, String).

isDestFileValid

public boolean isDestFileValid()

Returns whether the downloaded file is valid by comparing the checksum and expectedChecksum values. Will perform a case-insensitive comparison between the values of checksum and expectedChecksum. NOTE: If no checksum algorithm and expected value were specified in the NioFileCopierWithProgressMeterResults, then this method will return false.

Returns:

true if the checksum from the downloaded file matches the expected checksum previously given by the user.