com.helger.photon.basic.app.io

Class FileRelativeIO

java.lang.Object

com.helger.photon.basic.app.io.FileRelativeIO

All Implemented Interfaces:

IFileRelativeIO, IMutableFileRelativeIO, IPathRelativeIO, Serializable

@Immutable
public class FileRelativeIO
extends Object
implements IMutableFileRelativeIO

Default implementation of IMutableFileRelativeIO.

Since:

7.1.1

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileRelativeIO(File aBasePath, boolean bCheckAccessRights)

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)
com.helger.commons.io.file.FileIOError	deleteDirectoryIfExisting(File fDir, boolean bDeleteRecursively)
com.helger.commons.io.file.FileIOError	deleteFile(File aFile)
com.helger.commons.io.file.FileIOError	deleteFileIfExisting(File aFile)
boolean	equals(Object o)
File	getBasePathFile()
protected com.helger.commons.io.file.FileOperationManager	getFileOperationMgr()
int	hashCode()
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

deleteDirectory, deleteDirectoryIfExisting, deleteFile, deleteFileIfExisting, getOutputStream, getOutputStream, getWriter, getWriter

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

existsDir, existsFile, getBasePath, getFile, getRelativeFilename, getResource

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

getInputStream, getReader

Constructor Detail

FileRelativeIO

public FileRelativeIO(@Nonnull
                      File aBasePath,
                      boolean bCheckAccessRights)

Method Detail

getFileOperationMgr

@Nonnull
 @OverrideOnDemand
protected com.helger.commons.io.file.FileOperationManager getFileOperationMgr()

getBasePathFile

@Nonnull
public File getBasePathFile()

Specified by:

getBasePathFile in interface IFileRelativeIO

Returns:

The base path. Never null.

createDirectory

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

Description copied from interface: IMutableFileRelativeIO

Create the appropriate directory if it is not existing

Specified by:

createDirectory in interface IMutableFileRelativeIO

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
public com.helger.commons.io.file.FileIOError deleteFile(@Nonnull
                                                                   File aFile)

Specified by:

deleteFile in interface IMutableFileRelativeIO

deleteFileIfExisting

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

Specified by:

deleteFileIfExisting in interface IMutableFileRelativeIO

deleteDirectory

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

Specified by:

deleteDirectory in interface IMutableFileRelativeIO

deleteDirectoryIfExisting

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

Specified by:

deleteDirectoryIfExisting in interface IMutableFileRelativeIO

renameFile

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

Specified by:

renameFile in interface IMutableFileRelativeIO

renameDir

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

Specified by:

renameDir in interface IMutableFileRelativeIO

saveFile

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

Description copied from interface: IMutableFileRelativeIO

Helper function for saving a file with correct error handling.

Specified by:

saveFile in interface IMutableFileRelativeIO

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
public com.helger.commons.state.ESuccess saveFile(@Nonnull
                                                            String sFilename,
                                                            @Nonnull
                                                            byte[] aBytes)

Description copied from interface: IMutableFileRelativeIO

Helper function for saving a file with correct error handling.

Specified by:

saveFile in interface IMutableFileRelativeIO

Parameters:

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

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

Returns:

ESuccess

appendFile

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

Description copied from interface: IMutableFileRelativeIO

Helper function for saving a file with correct error handling.

Specified by:

appendFile in interface IMutableFileRelativeIO

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
public com.helger.commons.state.ESuccess appendFile(@Nonnull
                                                              String sFilename,
                                                              @Nonnull
                                                              byte[] aBytes)

Description copied from interface: IMutableFileRelativeIO

Helper function for saving a file with correct error handling.

Specified by:

appendFile in interface IMutableFileRelativeIO

Parameters:

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

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

Returns:

ESuccess

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object