Package com.atlassian.oai.validator.model

Interface NormalisedPath

All Known Subinterfaces:
ApiPath
All Known Implementing Classes:
ApiPathImpl, NormalisedPathImpl
public interface NormalisedPath
A normalised representation of an API path.

Normalised paths are devoid of path prefixes and contain a normalised starting/ending slash to make comparisons easier.

  • Method Details

    • numberOfParts

      int numberOfParts()
      Returns:
      The number of path parts from the normalised path

    • part

      @Nonnull String part(int index)
      Returns:
      The path part at the given index
      Throws:
      IndexOutOfBoundsException - if the provided index is not a valid index

    • original

      @Nonnull String original()
      Returns:
      The original, un-normalised path string

    • normalised

      @Nonnull String normalised()
      Returns:
      The normalised path string, with prefixes removed and a standard treatment for leading/trailing slashes.