Package org.apache.maven.api.services

Interface ChecksumAlgorithmService

All Superinterfaces:

Service

@Experimental
public interface ChecksumAlgorithmService
extends Service

Checksum algorithms service.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ChecksumAlgorithmService.ChecksumAlgorithm	The checksum algorithm.
static interface	ChecksumAlgorithmService.ChecksumCalculator	The checksum calculator.

Method Summary

Modifier and Type	Method	Description
Map<ChecksumAlgorithmService.ChecksumAlgorithm,String>	calculate(byte[] data, Collection<ChecksumAlgorithmService.ChecksumAlgorithm> algorithms)	Calculates checksums for specified data.
Map<ChecksumAlgorithmService.ChecksumAlgorithm,String>	calculate(InputStream stream, Collection<ChecksumAlgorithmService.ChecksumAlgorithm> algorithms)	Calculates checksums for specified stream.
Map<ChecksumAlgorithmService.ChecksumAlgorithm,String>	calculate(ByteBuffer data, Collection<ChecksumAlgorithmService.ChecksumAlgorithm> algorithms)	Calculates checksums for specified data.
Map<ChecksumAlgorithmService.ChecksumAlgorithm,String>	calculate(Path file, Collection<ChecksumAlgorithmService.ChecksumAlgorithm> algorithms)	Calculates checksums for specified file.
Collection<String>	getChecksumAlgorithmNames()	Returns immutable collection of all supported algorithm names.
ChecksumAlgorithmService.ChecksumAlgorithm	select(String algorithmName)	Returns ChecksumAlgorithmService.ChecksumAlgorithm for given algorithm name, or throws if algorithm not supported.
Collection<ChecksumAlgorithmService.ChecksumAlgorithm>	select(Collection<String> algorithmNames)	Returns a collection of ChecksumAlgorithmService.ChecksumAlgorithm in same order as algorithm names are ordered, or throws if any of the algorithm name is not supported.

Method Details

getChecksumAlgorithmNames

@Nonnull
Collection<String> getChecksumAlgorithmNames()

Returns immutable collection of all supported algorithm names.

select

@Nonnull
ChecksumAlgorithmService.ChecksumAlgorithm select(@Nonnull
 String algorithmName)

Returns ChecksumAlgorithmService.ChecksumAlgorithm for given algorithm name, or throws if algorithm not supported.

Throws:

ChecksumAlgorithmServiceException - if asked algorithm name is not supported.

NullPointerException - if passed in name is null.

select

@Nonnull
Collection<ChecksumAlgorithmService.ChecksumAlgorithm> select(@Nonnull
 Collection<String> algorithmNames)

Returns a collection of ChecksumAlgorithmService.ChecksumAlgorithm in same order as algorithm names are ordered, or throws if any of the algorithm name is not supported. The returned collection has equal count of elements as passed in collection of names, and if names contains duplicated elements, the returned list of algorithms will have duplicates as well.

Throws:

ChecksumAlgorithmServiceException - if any asked algorithm name is not supported.

NullPointerException - if passed in list of names is null.

calculate

@Nonnull
Map<ChecksumAlgorithmService.ChecksumAlgorithm,String> calculate(@Nonnull
 byte[] data,
 @Nonnull
 Collection<ChecksumAlgorithmService.ChecksumAlgorithm> algorithms)

Calculates checksums for specified data.

Parameters:

data - The content for which to calculate checksums, must not be null.

algorithms - The checksum algorithms to use, must not be null.

Returns:

The calculated checksums, indexed by algorithms, never null.

Throws:

NullPointerException - if passed in any parameter is null.

calculate

@Nonnull
Map<ChecksumAlgorithmService.ChecksumAlgorithm,String> calculate(@Nonnull
 ByteBuffer data,
 @Nonnull
 Collection<ChecksumAlgorithmService.ChecksumAlgorithm> algorithms)

Calculates checksums for specified data.

Parameters:

data - The content for which to calculate checksums, must not be null.

algorithms - The checksum algorithms to use, must not be null.

Returns:

The calculated checksums, indexed by algorithms, never null.

Throws:

NullPointerException - if passed in any parameter is null.

calculate

@Nonnull
Map<ChecksumAlgorithmService.ChecksumAlgorithm,String> calculate(@Nonnull
 Path file,
 @Nonnull
 Collection<ChecksumAlgorithmService.ChecksumAlgorithm> algorithms)
                                                          throws IOException

Calculates checksums for specified file.

Parameters:

file - The file for which to calculate checksums, must not be null.

algorithms - The checksum algorithms to use, must not be null.

Returns:

The calculated checksums, indexed by algorithms, never null.

Throws:

NullPointerException - if passed in any parameter is null.

IOException - In case of any IO problem.

calculate

@Nonnull
Map<ChecksumAlgorithmService.ChecksumAlgorithm,String> calculate(@Nonnull
 InputStream stream,
 @Nonnull
 Collection<ChecksumAlgorithmService.ChecksumAlgorithm> algorithms)
                                                          throws IOException

Calculates checksums for specified stream. Upon this method returns, the stream will be depleted (fully read) but not closed.

Parameters:

stream - The stream for which to calculate checksums, must not be null.

algorithms - The checksum algorithms to use, must not be null.

Returns:

The calculated checksums, indexed by algorithms, never null.

Throws:

NullPointerException - if passed in any parameter is null.

IOException - In case of any IO problem.