Package org.apache.commons.io.input
Class MessageDigestCalculatingInputStream.Builder
java.lang.Object
org.apache.commons.io.build.AbstractSupplier<MessageDigestCalculatingInputStream,MessageDigestCalculatingInputStream.Builder>
org.apache.commons.io.build.AbstractOriginSupplier<MessageDigestCalculatingInputStream,MessageDigestCalculatingInputStream.Builder>
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 new
MessageDigestCalculatingInputStream
instance.
For example:
MessageDigestCalculatingInputStream s = MessageDigestCalculatingInputStream.builder()
.setPath(path)
.setMessageDigest("SHA-512")
.get();
- Since:
- 2.12.0
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()
Constructs a new instance.void
setMessageDigest
(String algorithm) Sets the name of the name of the message digest algorithm.void
setMessageDigest
(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, setBufferSizeDefault, 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
-
Field Details
-
messageDigest
-
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
get
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:
UnsupportedOperationException
- if the origin cannot provide an InputStream.IOException
- if an I/O error occurs.- See Also:
-
setMessageDigest
Sets the message digest.- Parameters:
messageDigest
- the message digest.
-
setMessageDigest
Sets the name of the name of the message digest algorithm.- 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:
NoSuchAlgorithmException
- if no Provider supports a MessageDigestSpi implementation for the specified algorithm.
-