com.helger.photon.basic.app.io

Interface IMutableFileRelativeIO

All Superinterfaces:

IFileRelativeIO, IPathRelativeIO, Serializable

All Known Implementing Classes:

FileRelativeIO

public interface IMutableFileRelativeIO
extends IFileRelativeIO

The mutable version of the IFileRelativeIO interface. It extends the base interface with writable methods relative to a certain directory.

Since:

7.1.1

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.state.ESuccess	appendFile(String sFilename, byte[] aBytes) Helper function for saving a file with correct error handling.
com.helger.commons.state.ESuccess	appendFile(String sFilename, String sContent, Charset aCharset) Helper function for saving a file with correct error handling.
com.helger.commons.io.file.FileIOError	createDirectory(String sRelativePath, boolean bRecursive) Create the appropriate directory if it is not existing
com.helger.commons.io.file.FileIOError	deleteDirectory(File fDir, boolean bDeleteRecursively)
default com.helger.commons.io.file.FileIOError	deleteDirectory(String sDirName, boolean bDeleteRecursively)
com.helger.commons.io.file.FileIOError	deleteDirectoryIfExisting(File fDir, boolean bDeleteRecursively)
default com.helger.commons.io.file.FileIOError	deleteDirectoryIfExisting(String sDirName, boolean bDeleteRecursively)
com.helger.commons.io.file.FileIOError	deleteFile(File aFile)
default com.helger.commons.io.file.FileIOError	deleteFile(String sFilename)
com.helger.commons.io.file.FileIOError	deleteFileIfExisting(File aFile)
default com.helger.commons.io.file.FileIOError	deleteFileIfExisting(String sFilename)
default OutputStream	getOutputStream(String sRelativePath) Get the OutputStream relative to the base path.
default OutputStream	getOutputStream(String sRelativePath, com.helger.commons.io.EAppend eAppend) Get the OutputStream relative to the base path
default Writer	getWriter(String sRelativePath, Charset aCharset) Get the Writer relative to the base path.
default Writer	getWriter(String sRelativePath, Charset aCharset, com.helger.commons.io.EAppend eAppend) Get the Writer relative to the base path.
com.helger.commons.io.file.FileIOError	renameDir(String sOldDirName, String sNewDirName)
com.helger.commons.io.file.FileIOError	renameFile(String sOldFilename, String sNewFilename)
com.helger.commons.state.ESuccess	saveFile(String sFilename, byte[] aBytes) Helper function for saving a file with correct error handling.
com.helger.commons.state.ESuccess	saveFile(String sFilename, String sContent, Charset aCharset) Helper function for saving a file with correct error handling.

Methods inherited from interface com.helger.photon.basic.app.io.IFileRelativeIO

existsDir, existsFile, getBasePath, getBasePathFile, getFile, getRelativeFilename, getResource

Methods inherited from interface com.helger.photon.basic.app.io.IPathRelativeIO

getInputStream, getReader

Method Detail

getOutputStream

@Nullable
default OutputStream getOutputStream(@Nonnull
                                                String sRelativePath)

Get the OutputStream relative to the base path. An eventually existing file is truncated.

Parameters:

sRelativePath - the relative path

Returns:

null if the path is not writable

See Also:

IFileRelativeIO.getBasePathFile()

getOutputStream

@Nullable
default OutputStream getOutputStream(@Nonnull
                                                String sRelativePath,
                                                @Nonnull
                                                com.helger.commons.io.EAppend eAppend)

Get the OutputStream relative to the base path

Parameters:

sRelativePath - the relative path

eAppend - Append or truncate mode. May not be null.

Returns:

null if the path is not writable

See Also:

IFileRelativeIO.getBasePathFile()

getWriter

@Nullable
default Writer getWriter(@Nonnull
                                    String sRelativePath,
                                    @Nonnull
                                    Charset aCharset)

Get the Writer relative to the base path. An eventually existing file is truncated.

Parameters:

sRelativePath - the relative path

aCharset - The charset to use. May not be null.

Returns:

null if the path is not writable

See Also:

IFileRelativeIO.getBasePathFile()

getWriter

@Nullable
default Writer getWriter(@Nonnull
                                    String sRelativePath,
                                    @Nonnull
                                    Charset aCharset,
                                    @Nonnull
                                    com.helger.commons.io.EAppend eAppend)

Get the Writer relative to the base path.

Parameters:

sRelativePath - the relative path

aCharset - The charset to use. May not be null.

eAppend - Append or truncate mode. May not be null.

Returns:

null if the path is not writable

See Also:

IFileRelativeIO.getBasePathFile()

createDirectory

@Nonnull
com.helger.commons.io.file.FileIOError createDirectory(@Nonnull
                                                                 String sRelativePath,
                                                                 boolean bRecursive)

Create the appropriate directory if it is not existing

Parameters:

sRelativePath - the relative path

bRecursive - if true all missing parent directories will be created

Returns:

Success indicator. Never null.

See Also:

IFileRelativeIO.getBasePathFile()

deleteFile

@Nonnull
default com.helger.commons.io.file.FileIOError deleteFile(@Nonnull
                                                                    String sFilename)

deleteFile

@Nonnull
com.helger.commons.io.file.FileIOError deleteFile(@Nonnull
                                                            File aFile)

deleteFileIfExisting

@Nonnull
default com.helger.commons.io.file.FileIOError deleteFileIfExisting(@Nonnull
                                                                              String sFilename)

deleteFileIfExisting

@Nonnull
com.helger.commons.io.file.FileIOError deleteFileIfExisting(@Nonnull
                                                                      File aFile)

deleteDirectory

@Nonnull
default com.helger.commons.io.file.FileIOError deleteDirectory(@Nonnull
                                                                         String sDirName,
                                                                         boolean bDeleteRecursively)

deleteDirectory

@Nonnull
com.helger.commons.io.file.FileIOError deleteDirectory(@Nonnull
                                                                 File fDir,
                                                                 boolean bDeleteRecursively)

deleteDirectoryIfExisting

@Nonnull
default com.helger.commons.io.file.FileIOError deleteDirectoryIfExisting(@Nonnull
                                                                                   String sDirName,
                                                                                   boolean bDeleteRecursively)

deleteDirectoryIfExisting

@Nonnull
com.helger.commons.io.file.FileIOError deleteDirectoryIfExisting(@Nonnull
                                                                           File fDir,
                                                                           boolean bDeleteRecursively)

renameFile

@Nonnull
com.helger.commons.io.file.FileIOError renameFile(@Nonnull
                                                            String sOldFilename,
                                                            @Nonnull
                                                            String sNewFilename)

renameDir

@Nonnull
com.helger.commons.io.file.FileIOError renameDir(@Nonnull
                                                           String sOldDirName,
                                                           @Nonnull
                                                           String sNewDirName)

saveFile

@Nonnull
com.helger.commons.state.ESuccess saveFile(@Nonnull
                                                     String sFilename,
                                                     @Nonnull
                                                     String sContent,
                                                     @Nonnull
                                                     Charset aCharset)

Helper function for saving a file with correct error handling.

Parameters:

sFilename - name of the file. May not be null.

sContent - the content to save. May not be null.

aCharset - The character set to use. May not be null.

Returns:

ESuccess

saveFile

@Nonnull
com.helger.commons.state.ESuccess saveFile(@Nonnull
                                                     String sFilename,
                                                     byte[] aBytes)

Helper function for saving a file with correct error handling.

Parameters:

sFilename - name of the file. May not be null.

aBytes - the bytes to be written. May not be null.

Returns:

ESuccess

appendFile

@Nonnull
com.helger.commons.state.ESuccess appendFile(@Nonnull
                                                       String sFilename,
                                                       @Nonnull
                                                       String sContent,
                                                       @Nonnull
                                                       Charset aCharset)

Helper function for saving a file with correct error handling.

Parameters:

sFilename - name of the file. May not be null.

sContent - the content to save. May not be null.

aCharset - The character set to use. May not be null.

Returns:

ESuccess

appendFile

@Nonnull
com.helger.commons.state.ESuccess appendFile(@Nonnull
                                                       String sFilename,
                                                       @Nonnull
                                                       byte[] aBytes)

Helper function for saving a file with correct error handling.

Parameters:

sFilename - name of the file. May not be null.

aBytes - the bytes to be written. May not be null.

Returns:

ESuccess