Package net.officefloor.web

Interface HttpInputPath

  • All Known Implementing Classes:
    HttpInputPathImpl
    public interface HttpInputPath
    Provides path details for the HttpInput.
    Author:
    Daniel Sagenschneider

    • Method Detail

      • isMatchPath

        boolean isMatchPath​(java.lang.String path,
                    int endingPathParameterTerminatingCharacter)
        Indicates if the path matches the HttpInput path.
        Parameters:
        path - Path.
        endingPathParameterTerminatingCharacter - Character value for the Character that terminates the ending path parameter. This is ignored if the last part of the path is static (i.e. only applies for last parameter to know when it terminates the path, e.g. /path/{last}). Should the last parameter consume the remainder of the path, provide -1 to indicate no terminating Character.
        Returns:
        true if the path matches the HttpInput path.

      • isPathParameters

        boolean isPathParameters()
        Indicates if the path contains parameters (e.g. /{param}).
        Returns:
        true if the path contains parameters.

      • createHttpPathFactory

        <T> HttpPathFactory<T> createHttpPathFactory​(java.lang.Class<T> valuesType)
                                      throws HttpException
        Creates the HttpPathFactory.
        Type Parameters:
        T - Value type.
        Parameters:
        valuesType - Type to use for obtaining values to construct the path. Should the path not contain parameters, it may be null.
        Returns:
        HttpPathFactory.
        Throws:
        HttpException - If required path parameters are not available on the values type.