flux.file

Interface DoubleFileParameter

All Superinterfaces:

SingleFileParameter

All Known Subinterfaces:

FileCopyAction, FileMoveAction, FileRenameAction, RenameableDoubleFileParameter

All Known Implementing Classes:

fluximpl.file.AbstractDoubleFileParameter, fluximpl.file.pgp.AbstractPgpAction, fluximpl.file.AbstractRenamableDoubleFileParameter, FileDecryptPgpAction, fluximpl.file.pgp.decrypt.FileDecryptPgpActionImpl, FileEncryptPgpAction, fluximpl.file.pgp.encrypt.FileEncryptPgpActionImpl, FileUnzipAction, fluximpl.file.zip.FileUnzipActionImpl, FileZipAction, fluximpl.file.zip.FileZipActionImpl

public interface DoubleFileParameter
extends SingleFileParameter

Used in file actions that operate using a source set of file parameters and a target set of file parameters.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
void	addTarget(TargetFileCriteria target) Accepts a set of target directories that receive files at the end of a file operation.
java.util.List<TargetFileCriteria>	getTargets() The set of target directories that receive files at the end of a file operation.
boolean	isPreserveDirectoryStructure() Indicates whether file directory hierarchies are preserved, or flattened, during a file operation.
void	setPreserveDirectoryStructure(boolean preserveDirectoryStructure) Sets whether file directory hierarchies are preserved, or flattened, during a file operation.

Methods inherited from interface flux.file.SingleFileParameter

addSource, clear, getSources

Method Detail

addTarget

void addTarget(TargetFileCriteria target)

Accepts a set of target directories that receive files at the end of a file operation.

Parameters:

target - A target directory that receives files at the end of a file operation.

Throws:

java.lang.IllegalArgumentException - If source is null.

isPreserveDirectoryStructure

boolean isPreserveDirectoryStructure()

Indicates whether file directory hierarchies are preserved, or flattened, during a file operation.

Returns:

Whether file directory hierarchies are preserved, or flattened, during a file operation.

setPreserveDirectoryStructure

void setPreserveDirectoryStructure(boolean preserveDirectoryStructure)

Sets whether file directory hierarchies are preserved, or flattened, during a file operation.

Parameters:

preserveDirectoryStructure - Whether file directory hierarchies are preserved, or flattened, during a file operation.

getTargets

java.util.List<TargetFileCriteria> getTargets()

The set of target directories that receive files at the end of a file operation.

Returns:

The set of target directories that receive files at the end of a file operation.