Package org.apache.commons.io.input
Class MessageDigestCalculatingInputStream.Builder
- java.lang.Object
-
- org.apache.commons.io.build.AbstractSupplier<T,B>
-
- org.apache.commons.io.build.AbstractOriginSupplier<T,B>
-
- org.apache.commons.io.build.AbstractStreamBuilder<MessageDigestCalculatingInputStream,MessageDigestCalculatingInputStream.Builder>
-
- org.apache.commons.io.input.MessageDigestCalculatingInputStream.Builder
-
- All Implemented Interfaces:
IOSupplier<MessageDigestCalculatingInputStream>
- Enclosing class:
- MessageDigestCalculatingInputStream
public static class MessageDigestCalculatingInputStream.Builder extends AbstractStreamBuilder<MessageDigestCalculatingInputStream,MessageDigestCalculatingInputStream.Builder>
Builds a newMessageDigestCalculatingInputStream
.For example:
MessageDigestCalculatingInputStream s = MessageDigestCalculatingInputStream.builder() .setPath(path) .setMessageDigest("SHA-512") .get();
- Since:
- 2.12.0
- See Also:
get()
-
-
Constructor Summary
Constructors Constructor Description Builder()
Constructs a newMessageDigestCalculatingInputStream.Builder
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessageDigestCalculatingInputStream
get()
Builds a newMessageDigestCalculatingInputStream
.void
setMessageDigest(java.lang.String algorithm)
Sets the name of the name of the message digest algorithm.void
setMessageDigest(java.security.MessageDigest messageDigest)
Sets the message digest.-
Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getCharset, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeMax, setCharset, setCharset, setOpenOptions
-
Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
setByteArray, setCharSequence, setFile, setFile, setInputStream, setOutputStream, setPath, setPath, setReader, setURI, setWriter
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.commons.io.function.IOSupplier
asSupplier
-
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructs a newMessageDigestCalculatingInputStream.Builder
.
-
-
Method Detail
-
get
public MessageDigestCalculatingInputStream get() throws java.io.IOException
Builds a newMessageDigestCalculatingInputStream
.You must set input that supports
AbstractStreamBuilder.getInputStream()
, otherwise, this method throws an exception.This builder use the following aspects:
AbstractStreamBuilder.getPath()
MessageDigest
- Returns:
- a new instance.
- Throws:
java.lang.NullPointerException
- if messageDigest is null.java.lang.IllegalStateException
- if theorigin
isnull
.java.lang.UnsupportedOperationException
- if the origin cannot be converted to anInputStream
.java.io.IOException
- if an I/O error occurs.- See Also:
AbstractStreamBuilder.getInputStream()
-
setMessageDigest
public void setMessageDigest(java.security.MessageDigest messageDigest)
Sets the message digest.The MD5 cryptographic algorithm is weak and should not be used.
- Parameters:
messageDigest
- the message digest.
-
setMessageDigest
public void setMessageDigest(java.lang.String algorithm) throws java.security.NoSuchAlgorithmException
Sets the name of the name of the message digest algorithm.The MD5 cryptographic algorithm is weak and should not be used.
- Parameters:
algorithm
- the name of the algorithm. See the MessageDigest section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.- Throws:
java.security.NoSuchAlgorithmException
- if no Provider supports a MessageDigestSpi implementation for the specified algorithm.
-
-