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

Interface WriteCommand

public interface WriteCommand

Command design pattern for writing files

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	IS_A_DIRECTORY_MESSAGE

Method Summary

Modifier and Type	Method and Description
default void	write(String filePath, InputStream content, FileWriteMode mode, boolean lock, boolean createParentDirectory) Writes a file under the considerations of FileSystem.write(String, InputStream, FileWriteMode, boolean, boolean)
void	write(String filePath, InputStream content, FileWriteMode mode, boolean lock, boolean createParentDirectory, String encoding) Deprecated. @write(String, InputStream, FileWriteMode, boolean, boolean) must be used instead. Writes a file under the considerations of FileSystem.write(String, InputStream, FileWriteMode, boolean, boolean, String)

Field Detail

IS_A_DIRECTORY_MESSAGE

static final String IS_A_DIRECTORY_MESSAGE

See Also:

Constant Field Values

Method Detail

write

@Deprecated
void write(String filePath,
                       InputStream content,
                       FileWriteMode mode,
                       boolean lock,
                       boolean createParentDirectory,
                       String encoding)

Deprecated. @write(String, InputStream, FileWriteMode, boolean, boolean) must be used instead. Writes a file under the considerations of FileSystem.write(String, InputStream, FileWriteMode, boolean, boolean, String)

Parameters:

filePath - the path of the file to be written

content - the content to be written into the file

mode - a FileWriteMode

lock - whether or not to lock the file

createParentDirectory - whether or not to attempt creating the parent directory if it doesn't exist.

encoding - when is a String, this attribute specifies the encoding to be used when writing. If not set, then it defaults to FileConnectorConfig.getDefaultWriteEncoding()

Throws:

IllegalArgumentException - if an illegal combination of arguments is supplied

write

default void write(String filePath,
                   InputStream content,
                   FileWriteMode mode,
                   boolean lock,
                   boolean createParentDirectory)

Writes a file under the considerations of FileSystem.write(String, InputStream, FileWriteMode, boolean, boolean)

Parameters:

filePath - the path of the file to be written

content - the content to be written into the file

mode - a FileWriteMode

lock - whether or not to lock the file

createParentDirectory - whether or not to attempt creating the parent directory if it doesn't exist.

Throws:

IllegalArgumentException - if an illegal combination of arguments is supplied