Interface PathMapping

All Known Implementing Classes:
MultiPathMapping, RegexpPathMapping, SimplePathMapping

public interface PathMapping
Provides an interface for a general path mapping.
Since:
2.4.10
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final PathMapping
    Implements an identity mapping
  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    map(@NotNull String path)
    Maps the given path to a new location.
    @NotNull String
    map(@NotNull String path, boolean reverse)
    Maps the given path to a new location.
  • Field Details

    • IDENTITY

      static final PathMapping IDENTITY
      Implements an identity mapping
  • Method Details

    • map

      @NotNull @NotNull String map(@NotNull @NotNull String path)
      Maps the given path to a new location.
      Parameters:
      path - the path
      Returns:
      the mapped path.
    • map

      @NotNull @NotNull String map(@NotNull @NotNull String path, boolean reverse)
      Maps the given path to a new location.
      Parameters:
      path - the path
      reverse - if true a reverse mapping is applied
      Returns:
      the mapped path.