Class JpaSort

java.lang.Object
org.springframework.data.domain.Sort
org.springframework.data.jpa.domain.JpaSort
All Implemented Interfaces:
Serializable, Iterable<Sort.Order>, Supplier<Stream<Sort.Order>>, Streamable<Sort.Order>

public class JpaSort extends Sort
Sort option for queries that wraps JPA meta-model Attributes for sorting.
Author:
Thomas Darimont, Oliver Gierke, Christoph Strobl, David Madden, Jens Schauder
See Also:
  • Method Details

    • of

      public static JpaSort of(jakarta.persistence.metamodel.Attribute<?,?>... attributes)
      Creates a new JpaSort for the given attributes with the default sort direction.
      Parameters:
      attributes - must not be null or empty.
    • of

      public static JpaSort of(JpaSort.Path<?,?>... paths)
      Creates a new JpaSort instance with the given JpaSort.Paths.
      Parameters:
      paths - must not be null or empty.
    • of

      public static JpaSort of(Sort.Direction direction, jakarta.persistence.metamodel.Attribute<?,?>... attributes)
      Creates a new JpaSort for the given direction and attributes.
      Parameters:
      direction - the sorting direction.
      attributes - must not be null or empty.
    • of

      public static JpaSort of(Sort.Direction direction, JpaSort.Path<?,?>... paths)
      Creates a new JpaSort for the given direction and JpaSort.Paths.
      Parameters:
      direction - the sorting direction.
      paths - must not be null or empty.
    • and

      public JpaSort and(@Nullable Sort.Direction direction, jakarta.persistence.metamodel.Attribute<?,?>... attributes)
      Returns a new JpaSort with the given sorting criteria added to the current one.
      Parameters:
      direction - can be null.
      attributes - must not be null.
      Returns:
    • and

      public JpaSort and(@Nullable Sort.Direction direction, JpaSort.Path<?,?>... paths)
      Returns a new JpaSort with the given sorting criteria added to the current one.
      Parameters:
      direction - can be null.
      paths - must not be null.
      Returns:
    • andUnsafe

      public JpaSort andUnsafe(@Nullable Sort.Direction direction, String... properties)
      Returns a new JpaSort with the given sorting criteria added to the current one.
      Parameters:
      direction - can be null.
      properties - must not be null or empty.
      Returns:
    • path

      public static <A extends jakarta.persistence.metamodel.Attribute<T, S>, T, S> JpaSort.Path<T,S> path(A attribute)
      Creates a new JpaSort.Path for the given Attribute.
      Parameters:
      attribute - must not be null.
      Returns:
    • path

      public static <P extends jakarta.persistence.metamodel.PluralAttribute<T, ?, S>, T, S> JpaSort.Path<T,S> path(P attribute)
      Creates a new JpaSort.Path for the given PluralAttribute.
      Parameters:
      attribute - must not be null.
      Returns:
    • unsafe

      public static JpaSort unsafe(String... properties)
      Creates new unsafe JpaSort based on given properties.
      Parameters:
      properties - must not be null or empty.
      Returns:
    • unsafe

      public static JpaSort unsafe(Sort.Direction direction, String... properties)
      Creates new unsafe JpaSort based on given Sort.Direction and properties.
      Parameters:
      direction - must not be null.
      properties - must not be null or empty.
      Returns:
    • unsafe

      public static JpaSort unsafe(Sort.Direction direction, List<String> properties)
      Creates new unsafe JpaSort based on given Sort.Direction and properties.
      Parameters:
      direction - must not be null.
      properties - must not be null or empty.
      Returns: