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

Interface ListCommand<A extends FileAttributes>

public interface ListCommand<A extends FileAttributes>

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,A>>	list(FileConnectorConfig config, String directoryPath, boolean recursive, Predicate<A> matcher) Deprecated.
default List<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,A>>	list(FileConnectorConfig config, String directoryPath, boolean recursive, Predicate<A> matcher, Long timeBetweenSizeCheck) Lists files under the considerations of FileSystem.list(FileConnectorConfig, String, boolean, Predicate)

Method Detail

list

@Deprecated
List<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,A>> list(FileConnectorConfig config,
                                                                                              String directoryPath,
                                                                                              boolean recursive,
                                                                                              Predicate<A> matcher)

Deprecated.

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

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 exist or is not a directory

list

default List<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,A>> list(FileConnectorConfig config,
                                                                                          String directoryPath,
                                                                                          boolean recursive,
                                                                                          Predicate<A> matcher,
                                                                                          Long timeBetweenSizeCheck)

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

timeBetweenSizeCheck - wait time between size checks to determine if a file is ready to be read in milliseconds.

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 exist or is not a directory