Package org.springframework.data.rest.core.projection

Interface ProjectionDefinitions

All Known Implementing Classes:
ProjectionDefinitionConfiguration
public interface ProjectionDefinitions
Interface to allow the lookup of a projection interface by source type and name. This allows the definition of projections with the same name for different source types.
Author:
Oliver Gierke

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getParameterName()
    Returns the request parameter to be used to expose the projection to the web.
    Class<?>
    getProjectionType(Class<?> sourceType, String name)
    Returns the projection type for the given source type and name.
    boolean
    hasProjectionFor(Class<?> sourceType)
    Returns whether we have a projection registered for the given source type.

  • Method Details

    • getProjectionType

      Class<?> getProjectionType(Class<?> sourceType, String name)
      Returns the projection type for the given source type and name.
      Parameters:
      sourceType - must not be null.
      name - must not be null or empty.
      Returns:

    • hasProjectionFor

      boolean hasProjectionFor(Class<?> sourceType)
      Returns whether we have a projection registered for the given source type.
      Parameters:
      sourceType - must not be null.
      Returns:

    • getParameterName

      String getParameterName()
      Returns the request parameter to be used to expose the projection to the web.
      Returns:
      the parameterName will never be null or empty.