com.helger.photon.basic.app.io

Interface IPathRelativeIO

All Superinterfaces:

Serializable

All Known Subinterfaces:

IMutablePathRelativeIO

All Known Implementing Classes:

PathRelativeFileIO

public interface IPathRelativeIO
extends Serializable

A read-only version of a path-relative IO component. For a version with explicitly modifying methods see IMutablePathRelativeIO.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default boolean	existsDir(String sRelativePath) Check if a directory relative to the base path exists
default boolean	existsFile(String sRelativePath) Check if a file relative to the base path exists
default String	getBasePath()
File	getBasePathFile()
default File	getFile(String sRelativePath) Get a File relative to the base path.
default InputStream	getInputStream(String sRelativePath) Get the InputStream relative to the base path
default Reader	getReader(String sRelativePath, Charset aCharset) Get the Reader relative to the base path
default String	getRelativeFilename(File aAbsoluteFile) Get the relative file name for the passed absolute file.
default com.helger.commons.io.resource.FileSystemResource	getResource(String sRelativePath) Get the file system resource relative to the base path

Method Detail

getBasePathFile

@Nonnull
File getBasePathFile()

Returns:

The base path. Never null.

getBasePath

@Nonnull
 @Nonempty
default String getBasePath()

Returns:

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

getFile

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

default 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

default 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
default 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
default 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
default 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()

getRelativeFilename

@Nullable
default 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.