AbstractLowCodeSaveOptionsProvider

AbstractLowCodeSaveOptionsProvider class

Implementation to provide multiple save options for processes that require multiple outputs. For example, SpreadsheetSplitter feature requires multiple destinations to save the split files.

class AbstractLowCodeSaveOptionsProvider;

Methods

MethodDescription
getSaveOptions(SplitPartInfo)Gets the save options from which to get the output settings for currently split part. Returning null denotes to skip given part.
finish(LowCodeSaveOptions)Releases resources after processing currently split part.
isNull()Checks whether the implementation object is null.

getSaveOptions(SplitPartInfo)

Gets the save options from which to get the output settings for currently split part. Returning null denotes to skip given part.

getSaveOptions(part: SplitPartInfo) : LowCodeSaveOptions;

Parameters:

ParameterTypeDescription
partSplitPartInfo

Returns

LowCodeSaveOptions

finish(LowCodeSaveOptions)

Releases resources after processing currently split part.

finish(part: LowCodeSaveOptions) : void;

Parameters:

ParameterTypeDescription
partLowCodeSaveOptionsthe save options used for currently split part.

Remarks

By default this method just closes the stream specified by the LowCodeSaveOptions.OutputStream directly(if the save options specified a Stream as destination). User may overwrite this method to control how to release resources according to their requirement and the implementation of GetSaveOptions(SplitPartInfo).

isNull()

Checks whether the implementation object is null.

isNull() : boolean;