com.io7m.smfj.processing.api

## Interface SMFFilterCommandContextType

- All Known Implementing Classes:
    SMFFilterCommandContext

      public interface SMFFilterCommandContextType

  The context used during filtering.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `default void` | `checkPreconditions()` Check preconditions for the type.
    `Path` | `currentPath()` The current path.
    `default Path` | `resolvePath(Path path)` Resolve a given path.
    `Path` | `sourceRoot()` The source root directory.

- - ### Method Detail

    - #### sourceRoot

          Path sourceRoot()

      The source root directory. If a filter causes files to be open, they must be descendants of this directory.
      Returns:
        A source root directory

    - #### currentPath

          Path currentPath()

      The current path. If a filter command specifies a relative path, the path is resolved relative to the current path.
      Returns:
        The current path
      See Also:
        `resolvePath(Path)`

    - #### checkPreconditions

          default void checkPreconditions()

      Check preconditions for the type.

    - #### resolvePath

          default Path resolvePath(Path path)
                            throws IllegalArgumentException

      Resolve a given path.
      Parameters:
        `path` - The path
      Returns:
        A resolved path
      Throws:
        `IllegalArgumentException` - Iff the resolved path would fall outside of the source root

Copyright © 2017 <code@io7m.com> http://io7m.com