Class MultipartInput.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<MultipartInput,MultipartInput.Builder>
-
- org.apache.commons.fileupload2.core.MultipartInput.Builder
-
- All Implemented Interfaces:
org.apache.commons.io.function.IOSupplier<MultipartInput>
- Enclosing class:
- MultipartInput
public static class MultipartInput.Builder extends org.apache.commons.io.build.AbstractStreamBuilder<MultipartInput,MultipartInput.Builder>
Builds a newMultipartInputinstance.For example:
MultipartInput factory = MultipartInput.builder().setPath(path).setBufferSize(DEFAULT_THRESHOLD).get();
-
-
Constructor Summary
Constructors Constructor Description Builder()Constructs a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MultipartInputget()Constructs a new instance.intgetPartHeaderSizeMax()Returns the per part size limit for headers.MultipartInput.BuildersetBoundary(byte[] boundary)Sets the boundary.MultipartInput.BuildersetPartHeaderSizeMax(int partHeaderSizeMax)Sets the per part size limit for headers.MultipartInput.BuildersetProgressNotifier(MultipartInput.ProgressNotifier progressNotifier)Sets the progress notifier.-
Methods inherited from class org.apache.commons.io.build.AbstractStreamBuilder
getBufferSize, getBufferSizeDefault, getChannel, getCharSequence, getCharset, getCharsetDefault, getFile, getInputStream, getOpenOptions, getOutputStream, getPath, getRandomAccessFile, getReader, getWriter, setBufferSize, setBufferSize, setBufferSizeChecker, setBufferSizeDefault, setBufferSizeMax, setCharset, setCharset, setCharsetDefault, setOpenOptions
-
Methods inherited from class org.apache.commons.io.build.AbstractOriginSupplier
checkOrigin, getOrigin, hasOrigin, newByteArrayOrigin, newChannelOrigin, newCharSequenceOrigin, newFileOrigin, newFileOrigin, newInputStreamOrigin, newOutputStreamOrigin, newPathOrigin, newPathOrigin, newRandomAccessFileOrigin, newRandomAccessFileOrigin, newReaderOrigin, newURIOrigin, newWriterOrigin, setByteArray, setChannel, setCharSequence, setFile, setFile, setInputStream, setOrigin, setOutputStream, setPath, setPath, setRandomAccessFile, setRandomAccessFile, setReader, setURI, setWriter
-
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructs a new instance.
-
-
Method Detail
-
get
public MultipartInput get() throws java.io.IOException
Constructs a new instance.This builder uses the InputStream, buffer size, boundary and progress notifier aspects.
You must provide an origin that can be converted to a Reader by this builder, otherwise, this call will throw an
UnsupportedOperationException.- Returns:
- a new instance.
- Throws:
java.io.IOException- if an I/O error occurs.java.lang.UnsupportedOperationException- if the origin cannot provide a Path.- See Also:
AbstractOrigin.getReader(Charset)
-
getPartHeaderSizeMax
public int getPartHeaderSizeMax()
Returns the per part size limit for headers.- Returns:
- The maximum size of the headers in bytes.
- Since:
- 2.0.0-M4
-
setBoundary
public MultipartInput.Builder setBoundary(byte[] boundary)
Sets the boundary.- Parameters:
boundary- the boundary.- Returns:
thisinstance.
-
setPartHeaderSizeMax
public MultipartInput.Builder setPartHeaderSizeMax(int partHeaderSizeMax)
Sets the per part size limit for headers.- Parameters:
partHeaderSizeMax- The maximum size of the headers in bytes.- Returns:
- This builder.
- Since:
- 2.0.0-M4
-
setProgressNotifier
public MultipartInput.Builder setProgressNotifier(MultipartInput.ProgressNotifier progressNotifier)
Sets the progress notifier.- Parameters:
progressNotifier- progress notifier.- Returns:
thisinstance.
-
-