= HashUtils
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Utilities related to byte data hashing algorithms, at least providing MD5.

ConsiderApache Commons Codecfor a more comprehensive suite of digest utilities.

== API

[source,java]
.HashUtils.java
----
class HashUtils {
  Try<Hash> tryDigest(HashAlgorithm algorithm, byte[] bytes, int buffersize)     // <.>
  Try<Hash> tryDigest(HashAlgorithm algorithm, DataSource dataSource, int buffersize)     // <.>
}
----

<.> xref:#tryDigest_HashAlgorithm_byte_int[tryDigest(HashAlgorithm, byte, int)]
+
--
Optimized for when the input byte array is already present in memory.
--
<.> xref:#tryDigest_HashAlgorithm_DataSource_int[tryDigest(HashAlgorithm, DataSource, int)]
+
--
Optimized for direct _InputStream_ processing, if possible, not reading all data into memory at once.
--

== Members

[#tryDigest_HashAlgorithm_byte_int]
=== tryDigest(HashAlgorithm, byte, int)

Optimized for when the input byte array is already present in memory.

[#tryDigest_HashAlgorithm_DataSource_int]
=== tryDigest(HashAlgorithm, DataSource, int)

Optimized for direct _InputStream_ processing, if possible, not reading all data into memory at once.
