Package org.apache.commons.io.input
Class MessageDigestInputStream.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<MessageDigestInputStream,MessageDigestInputStream.Builder>
-
- org.apache.commons.io.input.MessageDigestInputStream.Builder
-
- All Implemented Interfaces:
IOSupplier<MessageDigestInputStream>
- Enclosing class:
- MessageDigestInputStream
public static class MessageDigestInputStream.Builder extends AbstractStreamBuilder<MessageDigestInputStream,MessageDigestInputStream.Builder>
Builds newMessageDigestInputStream
instances.For example:
MessageDigestInputStream s = MessageDigestInputStream.builder() .setPath(path) .setMessageDigest("SHA-512") .get();
You must specify a message digest algorithm name or instance.
-
-
Constructor Summary
Constructors Constructor Description Builder()
Constructs a new Builder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessageDigestInputStream
get()
Constructs a new instance.MessageDigestInputStream.Builder
setMessageDigest(java.lang.String algorithm)
Sets the name of the name of the message digest algorithm.MessageDigestInputStream.Builder
setMessageDigest(java.security.MessageDigest messageDigest)
Sets the message digest.-
Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getCharSequence, getCharset, getCharsetDefault, getInputStream, getOpenOptions, getOutputStream, getPath, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions
-
Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setReader, setURI, setWriter
-
Methods inherited from class org.apache.commons.io.build.AbstractSupplier
asThis
-
Methods inherited from class java.lang.Object
clone, equals, finalize, 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 new Builder.
-
-
Method Detail
-
get
public MessageDigestInputStream get() throws java.io.IOException
Constructs a new instance.This builder use the aspects InputStream, OpenOption[], and MessageDigest.
You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
UnsupportedOperationException
.- Returns:
- a new instance.
- Throws:
java.lang.UnsupportedOperationException
- if the origin cannot provide an InputStream.java.io.IOException
- if an I/O error occurs.- See Also:
AbstractStreamBuilder.getInputStream()
-
setMessageDigest
public MessageDigestInputStream.Builder 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.- Returns:
- this
-
setMessageDigest
public MessageDigestInputStream.Builder 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.- Returns:
- this
- Throws:
java.security.NoSuchAlgorithmException
- if no Provider supports a MessageDigestSpi implementation for the specified algorithm.
-
-