com.linkedin.multipart

Class MultiPartMIMEWriter.Builder

java.lang.Object

com.linkedin.multipart.MultiPartMIMEWriter.Builder

Enclosing class:

MultiPartMIMEWriter

public static class MultiPartMIMEWriter.Builder
extends java.lang.Object

Builder to create the MultiPartMIMEWriter.

Constructor Summary

Constructors

Constructor and Description
Builder() Create a MultiPartMIMEWriter without a preamble or epilogue.
Builder(java.lang.String preamble, java.lang.String epilogue) Create a MultiPartMIMEWriter Builder using the specified preamble and epilogue.

Method Summary

Modifier and Type	Method and Description
MultiPartMIMEWriter.Builder	appendDataSource(MultiPartMIMEDataSourceWriter dataSource) Append a MultiPartMIMEDataSourceWriter to be placed in the multipart mime envelope.
MultiPartMIMEWriter.Builder	appendDataSourceIterator(MultiPartMIMEDataSourceIterator multiPartMIMEDataSourceIterator) Append a MultiPartMIMEDataSourceIterator to be used as a non-nested data source within the multipart mime envelope.
MultiPartMIMEWriter.Builder	appendDataSources(java.util.List<MultiPartMIMEDataSourceWriter> dataSources) Append multiple MultiPartMIMEDataSourceWriters into the multipart mime envelope.
MultiPartMIMEWriter	build() Construct and return the newly formed MultiPartMIMEWriter.
int	getCurrentSize() Returns the number of MultiPartMIMEDataSourceWriters and MultiPartMIMEDataSourceIterators that have been added thus far.
MultiPartMIMEWriter.Builder	prependDataSource(MultiPartMIMEDataSourceWriter dataSource) Prepend a MultiPartMIMEDataSourceWriter to be placed in the multipart mime envelope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(java.lang.String preamble,
               java.lang.String epilogue)

Create a MultiPartMIMEWriter Builder using the specified preamble and epilogue. Only non-null values are permitted here. Empty strings are used to signify missing values.

Parameters:

preamble - non-null String to be placed before the multipart mime envelope according to the RFC.

epilogue - non-null String to be placed after the multipart mime enveloped according to the RFC.

Builder

public Builder()

Create a MultiPartMIMEWriter without a preamble or epilogue.

Method Detail

appendDataSource

public MultiPartMIMEWriter.Builder appendDataSource(MultiPartMIMEDataSourceWriter dataSource)

Append a MultiPartMIMEDataSourceWriter to be placed in the multipart mime envelope.

Parameters:

dataSource - the data source to be added.

Returns:

the builder to continue building.

appendDataSourceIterator

public MultiPartMIMEWriter.Builder appendDataSourceIterator(MultiPartMIMEDataSourceIterator multiPartMIMEDataSourceIterator)

Append a MultiPartMIMEDataSourceIterator to be used as a non-nested data source within the multipart mime envelope. All the individual parts read using the MultiPartMIMEDataSourceIterator will be placed one by one into this new envelope with boundaries replaced.

Parameters:

multiPartMIMEDataSourceIterator - the MultiPartMIMEDataSourceIterator that will be used to produce multiple parts.

Returns:

the builder to continue building.

appendDataSources

public MultiPartMIMEWriter.Builder appendDataSources(java.util.List<MultiPartMIMEDataSourceWriter> dataSources)

Append multiple MultiPartMIMEDataSourceWriters into the multipart mime envelope.

Parameters:

dataSources - the data sources to be added.

Returns:

the builder to continue building.

prependDataSource

public MultiPartMIMEWriter.Builder prependDataSource(MultiPartMIMEDataSourceWriter dataSource)

Prepend a MultiPartMIMEDataSourceWriter to be placed in the multipart mime envelope. This data source will be placed at the beginning of the envelope and all existing data sources provided to this builder thus far will shift forward by 1.

Parameters:

dataSource - the data source to be added at the beginning of the envelope.

Returns:

the builder to continue building.

getCurrentSize

public int getCurrentSize()

Returns the number of MultiPartMIMEDataSourceWriters and MultiPartMIMEDataSourceIterators that have been added thus far.

Returns:

the total count of data sources added thus far.

build

public MultiPartMIMEWriter build()

Construct and return the newly formed MultiPartMIMEWriter.

Returns:

the fully constructed MultiPartMIMEWriter.