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

Interface ListCommand

public interface ListCommand

Command design pattern for listing files

Since:

1.0

Method Summary

Modifier and Type	Method and Description
List<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FileAttributes>>	list(FileConnectorConfig config, String directoryPath, boolean recursive, org.mule.runtime.api.metadata.MediaType mediaType, Predicate<FileAttributes> matcher) Lists files under the considerations of FileSystem.list(FileConnectorConfig, String, boolean, MediaType, Predicate)

Method Detail

list

List<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FileAttributes>> list(FileConnectorConfig config,
                                                                                               String directoryPath,
                                                                                               boolean recursive,
                                                                                               org.mule.runtime.api.metadata.MediaType mediaType,
                                                                                               Predicate<FileAttributes> matcher)

Lists files under the considerations of FileSystem.list(FileConnectorConfig, String, boolean, MediaType, 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

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

mediaType - the MediaType of the message which entered the operation

Returns:

a List of Result objects each one containing each file's content in the payload and metadata in the attributes

Throws:

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