Package akka.http.javadsl.server

Class PathMatchers

  • public final class PathMatchers
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      PathMatchers()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PathMatcher1<java.lang.Double> doubleSegment()
      A PathMatcher that matches and extracts a Double value.
      static PathMatcher1<java.lang.Integer> hexIntegerSegment()
      A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Int value.
      static PathMatcher1<java.lang.Long> hexLongSegment()
      A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Long value.
      static PathMatcher1<java.lang.Integer> integerSegment()
      A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Int value.
      static PathMatcher1<java.lang.Long> longSegment()
      A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Long value.
      static PathMatcher0 neutral()
      A PathMatcher that always matches, doesn't consume anything and extracts nothing.
      static PathMatcher0 pathEnd()
      A PathMatcher that matches the very end of the requests URI path.
      static PathMatcher1<java.lang.String> remaining()
      A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path as an (encoded!)
      static PathMatcher1<Uri.Path> remainingPath()
      A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path.
      static PathMatcher1<java.lang.String> segment()
      A PathMatcher that matches if the unmatched path starts with a path segment.
      static PathMatcher0 segment​(java.lang.String segment)
      Creates a PathMatcher that consumes (a prefix of) the first path segment (if the path begins with a segment).
      static PathMatcher1<java.lang.String> segment​(java.util.regex.Pattern regex)
      Creates a PathMatcher that consumes (a prefix of) the first path segment if the path begins with a segment (a prefix of) which matches the given regex.
      static PathMatcher1<java.util.List<java.lang.String>> segments()
      A PathMatcher that matches up to 128 remaining segments as a List[String].
      static PathMatcher1<java.util.List<java.lang.String>> segments​(int count)
      A PathMatcher that matches the given number of path segments (separated by slashes) as a List[String].
      static PathMatcher1<java.util.List<java.lang.String>> segments​(int min, int max)
      A PathMatcher that matches between min and max (both inclusively) path segments (separated by slashes) as a List[String].
      static PathMatcher0 separateOnSlashes​(java.lang.String segments)
      Converts a path string containing slashes into a PathMatcher that interprets slashes as path segment separators.
      static PathMatcher0 slash()
      A PathMatcher that matches a single slash character ('/').
      static PathMatcher1<java.util.UUID> uuidSegment()
      A PathMatcher that matches and extracts a java.util.UUID instance.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PathMatchers

        public PathMatchers()

    • Method Detail

      • separateOnSlashes

        public static PathMatcher0 separateOnSlashes​(java.lang.String segments)
        Converts a path string containing slashes into a PathMatcher that interprets slashes as path segment separators.
        Parameters:
        segments - (undocumented)
        Returns:
        (undocumented)

      • slash

        public static PathMatcher0 slash()
        A PathMatcher that matches a single slash character ('/').
        Returns:
        (undocumented)

      • segment

        public static PathMatcher0 segment​(java.lang.String segment)
        Creates a PathMatcher that consumes (a prefix of) the first path segment (if the path begins with a segment).
        Parameters:
        segment - (undocumented)
        Returns:
        (undocumented)

      • segment

        public static PathMatcher1<java.lang.String> segment​(java.util.regex.Pattern regex)
        Creates a PathMatcher that consumes (a prefix of) the first path segment if the path begins with a segment (a prefix of) which matches the given regex. Extracts either the complete match (if the regex doesn't contain a capture group) or the capture group (if the regex contains exactly one). If the regex contains more than one capture group the method throws an IllegalArgumentException.
        Parameters:
        regex - (undocumented)
        Returns:
        (undocumented)

      • segments

        public static PathMatcher1<java.util.List<java.lang.String>> segments​(int min,
                                                                      int max)
        A PathMatcher that matches between min and max (both inclusively) path segments (separated by slashes) as a List[String]. If there are more than count segments present the remaining ones will be left unmatched. If the path has a trailing slash this slash will *not* be matched.
        Parameters:
        min - (undocumented)
        max - (undocumented)
        Returns:
        (undocumented)

      • segments

        public static PathMatcher1<java.util.List<java.lang.String>> segments​(int count)
        A PathMatcher that matches the given number of path segments (separated by slashes) as a List[String]. If there are more than count segments present the remaining ones will be left unmatched. If the path has a trailing slash this slash will *not* be matched.
        Parameters:
        count - (undocumented)
        Returns:
        (undocumented)

      • integerSegment

        public static PathMatcher1<java.lang.Integer> integerSegment()
        A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Int value. The matcher will not match 0 digits or a sequence of digits that would represent an Int value larger than Int.MaxValue.
        Returns:
        (undocumented)

      • longSegment

        public static PathMatcher1<java.lang.Long> longSegment()
        A PathMatcher that efficiently matches a number of digits and extracts their (non-negative) Long value. The matcher will not match 0 digits or a sequence of digits that would represent an Long value larger than Long.MaxValue.
        Returns:
        (undocumented)

      • hexIntegerSegment

        public static PathMatcher1<java.lang.Integer> hexIntegerSegment()
        A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Int value. The matcher will not match 0 digits or a sequence of digits that would represent an Int value larger than Int.MaxValue.
        Returns:
        (undocumented)

      • hexLongSegment

        public static PathMatcher1<java.lang.Long> hexLongSegment()
        A PathMatcher that efficiently matches a number of hex-digits and extracts their (non-negative) Long value. The matcher will not match 0 digits or a sequence of digits that would represent an Long value larger than Long.MaxValue.
        Returns:
        (undocumented)

      • doubleSegment

        public static PathMatcher1<java.lang.Double> doubleSegment()
        A PathMatcher that matches and extracts a Double value. The matched string representation is the pure decimal, optionally signed form of a double value, i.e. without exponent.
        Returns:
        (undocumented)

      • uuidSegment

        public static PathMatcher1<java.util.UUID> uuidSegment()
        A PathMatcher that matches and extracts a java.util.UUID instance.
        Returns:
        (undocumented)

      • neutral

        public static PathMatcher0 neutral()
        A PathMatcher that always matches, doesn't consume anything and extracts nothing. Serves mainly as a neutral element in PathMatcher composition.
        Returns:
        (undocumented)

      • pathEnd

        public static PathMatcher0 pathEnd()
        A PathMatcher that matches the very end of the requests URI path.
        Returns:
        (undocumented)

      • remaining

        public static PathMatcher1<java.lang.String> remaining()
        A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path as an (encoded!) String.
        Returns:
        (undocumented)

      • remainingPath

        public static PathMatcher1<Uri.Path> remainingPath()
        A PathMatcher that matches and extracts the complete remaining, unmatched part of the request's URI path.
        Returns:
        (undocumented)

      • segment

        public static PathMatcher1<java.lang.String> segment()
        A PathMatcher that matches if the unmatched path starts with a path segment. If so the path segment is extracted as a String.
        Returns:
        (undocumented)

      • segments

        public static PathMatcher1<java.util.List<java.lang.String>> segments()
        A PathMatcher that matches up to 128 remaining segments as a List[String]. This can also be no segments resulting in the empty list. If the path has a trailing slash this slash will *not* be matched.
        Returns:
        (undocumented)