Package com.helger.commons.io.relative

Interface IPathRelativeIO

All Known Subinterfaces:
IFileRelativeIO
All Known Implementing Classes:
FileRelativeIO, PathRelativeIO
public interface IPathRelativeIO
A read-only version of a path-relative IO component.
Author:
Philip Helger

  • Method Details

    • getBasePath

      @Nonnull @Nonempty String getBasePath()
      Returns:
      The base path. May be a file path, a URL or whatever. Never null.

    • getResource

      @Nonnull IReadableResource getResource(@Nonnull String sRelativePath)
      Get the file system resource relative to the base path. This method CAN NOT handle absolute paths!
      Parameters:
      sRelativePath - the relative path
      Returns:
      The "absolute" IReadableResource and never null.

    • 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

    • 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