com.helger.photon.basic.app.io

Interface IPathRelativeIO

All Known Implementing Classes:

PathRelativeFileIO

public interface IPathRelativeIO

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	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.
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.
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.

Method Detail

getBasePathFile

@Nonnull
File getBasePathFile()

Returns:

The base path. Never null.

getBasePath

@Nonnull
@Nonempty
String getBasePath()

Returns:

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

getFile

@Nonnull
File getFile(@Nonnull
                   String sRelativePath)

Get a File relative to the base path.

Parameters:

sRelativePath - the relative path

Returns:

The "absolute" File and never null.

See Also:

getBasePathFile()

existsFile

boolean existsFile(@Nonnull
                 String sRelativePath)

Check if a file relative to the base path exists

Parameters:

sRelativePath - the relative path

Returns:

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

See Also:

getBasePathFile()

existsDir

boolean existsDir(@Nonnull
                String sRelativePath)

Check if a directory relative to the base path exists

Parameters:

sRelativePath - the relative path

Returns:

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

See Also:

getBasePathFile()

getResource

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

Get the file system resource relative to the base path

Parameters:

sRelativePath - the relative path

Returns:

The "absolute" FileSystemResource and never null.

See Also:

getBasePathFile()

getInputStream

@Nullable
InputStream getInputStream(@Nonnull
                                  String sRelativePath)

Get the InputStream relative to the base path

Parameters:

sRelativePath - the relative path

Returns:

null if the path does not exist

See Also:

getBasePathFile()

getReader

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

Get the Reader relative to the base path

Parameters:

sRelativePath - the relative path

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

Returns:

null if the path does not exist

See Also:

getBasePathFile()

getOutputStream

@Nullable
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:

getBasePathFile()

getOutputStream

@Nullable
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:

getBasePathFile()

getWriter

@Nullable
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:

getBasePathFile()

getWriter

@Nullable
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:

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:

getBasePathFile()

deleteFile

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

deleteFile

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

deleteFileIfExisting

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

deleteFileIfExisting

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

deleteDirectory

@Nonnull
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
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

getRelativeFilename

@Nullable
String getRelativeFilename(@Nonnull
                                  File aAbsoluteFile)

Get the relative file name for the passed absolute file.

Parameters:

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

Returns:

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