com.helger.photon.basic.app.io

Class PathRelativeFileIO

java.lang.Object

com.helger.photon.basic.app.io.PathRelativeFileIO

All Implemented Interfaces:

IPathRelativeIO

@Immutable
public class PathRelativeFileIO
extends Object
implements IPathRelativeIO

Default implementation of IPathRelativeIO.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PathRelativeFileIO(File aBasePath, boolean bCheckAccessRights)

Method Summary

Methods

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	deleteDirectory(String sDirName, boolean bDeleteRecursively)
com.helger.commons.io.file.FileIOError	deleteDirectoryIfExisting(File fDir, boolean bDeleteRecursively)
com.helger.commons.io.file.FileIOError	deleteDirectoryIfExisting(String sDirName, boolean bDeleteRecursively)
com.helger.commons.io.file.FileIOError	deleteFile(File aFile)
com.helger.commons.io.file.FileIOError	deleteFile(String sFilename)
com.helger.commons.io.file.FileIOError	deleteFileIfExisting(File aFile)
com.helger.commons.io.file.FileIOError	deleteFileIfExisting(String sFilename)
boolean	equals(Object o)
boolean	existsDir(String sRelativePath) Check if a directory relative to the base path exists
boolean	existsFile(String sRelativePath) Check if a file relative to the base path exists
String	getBasePath()
File	getBasePathFile()
File	getFile(String sRelativePath) Get a File relative to the base path.
protected com.helger.commons.io.file.FileOperationManager	getFileOperationMgr()
InputStream	getInputStream(String sRelativePath) Get the InputStream relative to the base path
OutputStream	getOutputStream(String sRelativePath) Get the OutputStream relative to the base path.
OutputStream	getOutputStream(String sRelativePath, com.helger.commons.io.EAppend eAppend) Get the OutputStream relative to the base path
Reader	getReader(String sRelativePath, Charset aCharset) Get the Reader relative to the base path
String	getRelativeFilename(File aAbsoluteFile) Get the relative file name for the passed absolute file.
com.helger.commons.io.resource.FileSystemResource	getResource(String sRelativePath) Get the file system resource relative to the base path
Writer	getWriter(String sRelativePath, Charset aCharset) Get the Writer relative to the base path.
Writer	getWriter(String sRelativePath, Charset aCharset, com.helger.commons.io.EAppend eAppend) Get the Writer relative to the base path.
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

Constructor Detail

PathRelativeFileIO

public PathRelativeFileIO(@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 IPathRelativeIO

Returns:

The base path. Never null.

getBasePath

@Nonnull
@Nonempty
public String getBasePath()

Specified by:

getBasePath in interface IPathRelativeIO

Returns:

The absolute base path that is used. Neither null nor empty.

getFile

@Nonnull
public File getFile(@Nonnull
                   String sRelativePath)

Description copied from interface: IPathRelativeIO

Get a File relative to the base path.

Specified by:

getFile in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

Returns:

The "absolute" File and never null.

See Also:

IPathRelativeIO.getBasePathFile()

existsFile

public boolean existsFile(@Nonnull
                 String sRelativePath)

Description copied from interface: IPathRelativeIO

Check if a file relative to the base path exists

Specified by:

existsFile in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

Returns:

true if the File is a file and exists, false otherwise.

See Also:

IPathRelativeIO.getBasePathFile()

existsDir

public boolean existsDir(@Nonnull
                String sRelativePath)

Description copied from interface: IPathRelativeIO

Check if a directory relative to the base path exists

Specified by:

existsDir in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

Returns:

true if the File is a directory and exists, false otherwise.

See Also:

IPathRelativeIO.getBasePathFile()

getResource

@Nonnull
public com.helger.commons.io.resource.FileSystemResource getResource(@Nonnull
                                                                    String sRelativePath)

Description copied from interface: IPathRelativeIO

Get the file system resource relative to the base path

Specified by:

getResource in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

Returns:

The "absolute" FileSystemResource and never null.

See Also:

IPathRelativeIO.getBasePathFile()

getInputStream

@Nullable
public InputStream getInputStream(@Nonnull
                                  String sRelativePath)

Description copied from interface: IPathRelativeIO

Get the InputStream relative to the base path

Specified by:

getInputStream in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

Returns:

null if the path does not exist

See Also:

IPathRelativeIO.getBasePathFile()

getReader

@Nullable
public Reader getReader(@Nonnull
                        String sRelativePath,
                        @Nonnull
                        Charset aCharset)

Description copied from interface: IPathRelativeIO

Get the Reader relative to the base path

Specified by:

getReader in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

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

Returns:

null if the path does not exist

See Also:

IPathRelativeIO.getBasePathFile()

getOutputStream

@Nullable
public OutputStream getOutputStream(@Nonnull
                                    String sRelativePath)

Description copied from interface: IPathRelativeIO

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

Specified by:

getOutputStream in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

Returns:

null if the path is not writable

See Also:

IPathRelativeIO.getBasePathFile()

getOutputStream

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

Description copied from interface: IPathRelativeIO

Get the OutputStream relative to the base path

Specified by:

getOutputStream in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

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

Returns:

null if the path is not writable

See Also:

IPathRelativeIO.getBasePathFile()

getWriter

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

Description copied from interface: IPathRelativeIO

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

Specified by:

getWriter in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

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

Returns:

null if the path is not writable

See Also:

IPathRelativeIO.getBasePathFile()

getWriter

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

Description copied from interface: IPathRelativeIO

Get the Writer relative to the base path.

Specified by:

getWriter in interface IPathRelativeIO

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:

IPathRelativeIO.getBasePathFile()

createDirectory

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

Description copied from interface: IPathRelativeIO

Create the appropriate directory if it is not existing

Specified by:

createDirectory in interface IPathRelativeIO

Parameters:

sRelativePath - the relative path

bRecursive - if true all missing parent directories will be created

Returns:

Success indicator. Never null.

See Also:

IPathRelativeIO.getBasePathFile()

deleteFile

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

Specified by:

deleteFile in interface IPathRelativeIO

deleteFile

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

Specified by:

deleteFile in interface IPathRelativeIO

deleteFileIfExisting

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

Specified by:

deleteFileIfExisting in interface IPathRelativeIO

deleteFileIfExisting

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

Specified by:

deleteFileIfExisting in interface IPathRelativeIO

deleteDirectory

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

Specified by:

deleteDirectory in interface IPathRelativeIO

deleteDirectory

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

Specified by:

deleteDirectory in interface IPathRelativeIO

deleteDirectoryIfExisting

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

Specified by:

deleteDirectoryIfExisting in interface IPathRelativeIO

deleteDirectoryIfExisting

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

Specified by:

deleteDirectoryIfExisting in interface IPathRelativeIO

renameFile

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

Specified by:

renameFile in interface IPathRelativeIO

renameDir

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

Specified by:

renameDir in interface IPathRelativeIO

saveFile

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

Description copied from interface: IPathRelativeIO

Helper function for saving a file with correct error handling.

Specified by:

saveFile in interface IPathRelativeIO

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: IPathRelativeIO

Helper function for saving a file with correct error handling.

Specified by:

saveFile in interface IPathRelativeIO

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: IPathRelativeIO

Helper function for saving a file with correct error handling.

Specified by:

appendFile in interface IPathRelativeIO

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: IPathRelativeIO

Helper function for saving a file with correct error handling.

Specified by:

appendFile in interface IPathRelativeIO

Parameters:

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

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

Returns:

ESuccess

getRelativeFilename

@Nullable
public String getRelativeFilename(@Nonnull
                                  File aAbsoluteFile)

Description copied from interface: IPathRelativeIO

Get the relative file name for the passed absolute file.

Specified by:

getRelativeFilename in interface IPathRelativeIO

Parameters:

aAbsoluteFile - The non-null absolute file to make relative.

Returns:

null if the passed file is not a child of this base directory.

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