Interface ResourceDescriptor


  • public interface ResourceDescriptor
    A descriptor for a resource method.
    Author:
    Carl Harris
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean matches​(Class<?>... modelPath)
      Tests whether the given model path matches this method descriptor.
      boolean matches​(ModelPath modelPath)
      Tests whether the given model path matches this method descriptor.
      ModelPath modelPath()
      Gets the model path identified in a ModelPathSpec annotation on the described resource.
      String path()
      Gets the path to this resource method relative to the deployment context path and JAX-RS application path.
      PathTemplateResolver templateResolver()
      Gets a template resolver instance to use in resolving the path template for the described resource method.
    • Method Detail

      • path

        String path()
        Gets the path to this resource method relative to the deployment context path and JAX-RS application path.
        Returns:
        resource path template
      • modelPath

        ModelPath modelPath()
        Gets the model path identified in a ModelPathSpec annotation on the described resource.
        Returns:
        model path
      • matches

        boolean matches​(Class<?>... modelPath)
        Tests whether the given model path matches this method descriptor.
        Parameters:
        modelPath - the model path to test
        Returns:
        true if modelPath matches the path of model references associated with this method descriptor
      • matches

        boolean matches​(ModelPath modelPath)
        Tests whether the given model path matches this method descriptor.
        Parameters:
        modelPath - the model path to test
        Returns:
        true if modelPath matches the path of model references associated with this method descriptor
      • templateResolver

        PathTemplateResolver templateResolver()
        Gets a template resolver instance to use in resolving the path template for the described resource method.
        Returns:
        template resolver object of the type specified by the TemplateResolver annotation on the described resource method