Package com.yahoo.restapi

Class Path

java.lang.Object
com.yahoo.restapi.Path
public class Path extends Object
A path which is able to match strings containing bracketed placeholders and return the values given at the placeholders. The path is split on '/', and each part is then URL decoded. E.g a path /a/1/bar/fuz/baz/%62%2f will match /a/{foo}/bar/{b}/baz/{c} and return foo=1, b=fuz, and c=c/ Only full path elements may be placeholders, i.e /a{bar} is not interpreted as one. If the path spec ends with /{*}, it will match urls with any rest path. The rest path (not including the trailing slash) will be available as getRest(). Note that for convenience in common use this has state which changes as a side effect of each matches invocation. It is therefore for single thread use. An optional prefix can be used to match the path spec against an alternative path. This is used when you have alternative paths mapped to the same resource.
Author:
bratseth

  • Constructor Details

    • Path

      public Path(URI uri)

    • Path

      public Path(URI uri, String optionalPrefix)

  • Method Details

    • matches

      public boolean matches(String pathSpec)
      Parses the path according to pathSpec - must be called prior to get(java.lang.String) Returns whether this path matches the given template string. If the given template has placeholders, their values (accessible by get) are reset by calling this, whether or not the path matches the given template. This will NOT match empty path elements.
      Parameters:
      pathSpec - the path string to match to this
      Returns:
      true if the string matches, false otherwise

    • get

      public String get(String placeholder)
      Returns the value of the given template variable in the last path matched, or null if the previous matches call returned false or if this has not matched anything yet.

    • getRest

      public String getRest()
      Returns the rest of the last matched path. This is always the empty string (never null) unless the path spec ends with {*}

    • asString

      public String asString()

    • toString

      public String toString()
      Overrides:
      toString in class Object