public interface

PathMapper

com.atlassian.plugin.servlet.util.PathMapper
Known Indirect Subclasses

Class Overview

The PathMapper is used to map file patterns to keys, and find an approriate 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

Summary

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

Public Methods

public abstract String get (String path)

Retrieve appropriate key by matching patterns with supplied path.

public abstract Collection<String> getAll (String path)

Retrieve all mappings which match a supplied path.

public abstract void put (String key, String pattern)

Add a key and appropriate matching pattern.