flux.file
Interface SingleFileParameter

All Known Subinterfaces:

DoubleFileParameter, FileCopyAction, FileCreateAction, FileDeleteAction, FileExistTrigger, FileModifiedTrigger, FileMoveAction, FileNotExistTrigger, FileRenameAction, FileTrigger, RenameableDoubleFileParameter

All Known Implementing Classes:

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

public interface SingleFileParameter

File operations that use a single set of file parameters.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

void	addSource(IncludesFileCriteria source) Accepts a set of files and directories to operate on in the file operation.
void	clear() Removes all files and directories that will be operated on in the file operation.
java.util.List<IncludesFileCriteria>	getSources() Returns the set of files and directories that will be operated on in the file operation.

Method Detail

addSource

void addSource(IncludesFileCriteria source)
               throws java.lang.IllegalArgumentException

Accepts a set of files and directories to operate on in the file operation.

Parameters:

source - A group of files and directories to operate on.

Throws:

java.lang.IllegalArgumentException - If source is null.

clear

void clear()
           throws EngineException

Removes all files and directories that will be operated on in the file operation.

Throws:

EngineException - If a system error occurs.

getSources

java.util.List<IncludesFileCriteria> getSources()
                                                throws EngineException

Returns the set of files and directories that will be operated on in the file operation.

Returns:

All files and directories to be operated on.

Throws:

EngineException - If a system error occurs.