org.mule.extension.file.common.api.command

Interface ListCommand

public interface ListCommand

Command design pattern for listing files

Since:

4.0

Method Summary

Modifier and Type	Method and Description
TreeNode	list(FileConnectorConfig config, String directoryPath, boolean recursive, org.mule.runtime.api.message.Message message, Predicate<FileAttributes> matcher) Lists files under the considerations of FileSystem.list(FileConnectorConfig, String, boolean, Message, Predicate)

Method Detail

list

TreeNode list(FileConnectorConfig config,
              String directoryPath,
              boolean recursive,
              org.mule.runtime.api.message.Message message,
              Predicate<FileAttributes> matcher)

Lists files under the considerations of FileSystem.list(FileConnectorConfig, String, boolean, Message, Predicate)

Parameters:

config - the config that is parameterizing this operation

directoryPath - the path to the directory to be listed

recursive - whether to include the contents of sub-directories

message - the Message on which this operation was triggered

matcher - a Predicate of FileAttributes used to filter the output list

Returns:

a TreeNode object representing the listed directory

Throws:

IllegalArgumentException - if directoryPath points to a file which doesn't exists or is not a directory