Package com.atlassian.plugin.servlet.util

Interface PathMapper

All Known Implementing Classes:
DefaultPathMapper
public interface PathMapper
The PathMapper is used to map file patterns to keys, and find an appropriate key for a given file path. The pattern rules are consistent with those defined in the Servlet 2.3 API on the whole. Wildcard patterns are also supported, using any combination of * and ?.

Example

PathMapper pm = new PathMapper();

pm.put("one","/");
pm.put("two","/mydir/*");
pm.put("three","*.xml");
pm.put("four","/myexactfile.html");
pm.put("five","/*\/admin/*.??ml");

String result1 = pm.get("/mydir/myfile.xml"); // returns "two";
String result2 = pm.get("/mydir/otherdir/admin/myfile.html"); // returns "five";

This was copied from Atlassian Seraph 1.0

Since:
2.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    get(String path)
    Retrieve appropriate key by matching patterns with supplied path.
    Collection<String>
    getAll(String path)
    Retrieve all mappings which match a supplied path.
    void
    put(String key, String pattern)
    Add a key and appropriate matching pattern.

  • Method Details

    • get

      String get(String path)
      Retrieve appropriate key by matching patterns with supplied path.

    • getAll

      Collection<String> getAll(String path)
      Retrieve all mappings which match a supplied path.

    • put

      void put(String key, String pattern)
      Add a key and appropriate matching pattern.