Class MutableSortDefinition

java.lang.Object
org.springframework.beans.support.MutableSortDefinition
All Implemented Interfaces:
Serializable, SortDefinition
@Deprecated(since="7.0.3", forRemoval=true) public class MutableSortDefinition extends Object implements SortDefinition, Serializable
Deprecated, for removal: This API element is subject to removal in a future version.
as severely outdated and superseded by more modern solutions, for example in Spring Data Commons
Mutable implementation of the SortDefinition interface. Supports toggling the ascending value on setting the same property again.
Since:
26.05.2003
Author:
Juergen Hoeller, Jean-Pierre Pawlak
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    MutableSortDefinition()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create an empty MutableSortDefinition, to be populated via its bean properties.
    MutableSortDefinition(boolean toggleAscendingOnSameProperty)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new MutableSortDefinition.
    MutableSortDefinition(String property, boolean ignoreCase, boolean ascending)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a MutableSortDefinition for the given settings.
    MutableSortDefinition(SortDefinition source)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Copy constructor: create a new MutableSortDefinition that mirrors the given sort definition.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(@Nullable Object other)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getProperty()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the name of the bean property to compare.
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isAscending()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return whether to sort ascending (true) or descending (false).
    boolean
    isIgnoreCase()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return whether upper and lower case in String values should be ignored.
    boolean
    isToggleAscendingOnProperty()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return whether to toggle the ascending flag if the same property gets set again (that is, setProperty gets called with already set property name again).
    void
    setAscending(boolean ascending)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set whether to sort ascending (true) or descending (false).
    void
    setIgnoreCase(boolean ignoreCase)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set whether upper and lower case in String values should be ignored.
    void
    setProperty(String property)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the property to compare.
    void
    setToggleAscendingOnProperty(boolean toggleAscendingOnProperty)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set whether to toggle the ascending flag if the same property gets set again (that is, setProperty(String) gets called with already set property name again).

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MutableSortDefinition

      public MutableSortDefinition()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create an empty MutableSortDefinition, to be populated via its bean properties.
      See Also:

    • MutableSortDefinition

      public MutableSortDefinition(SortDefinition source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Copy constructor: create a new MutableSortDefinition that mirrors the given sort definition.
      Parameters:
      source - the original sort definition

    • MutableSortDefinition

      public MutableSortDefinition(String property, boolean ignoreCase, boolean ascending)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a MutableSortDefinition for the given settings.
      Parameters:
      property - the property to compare
      ignoreCase - whether upper and lower case in String values should be ignored
      ascending - whether to sort ascending (true) or descending (false)

    • MutableSortDefinition

      public MutableSortDefinition(boolean toggleAscendingOnSameProperty)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new MutableSortDefinition.
      Parameters:
      toggleAscendingOnSameProperty - whether to toggle the ascending flag if the same property gets set again (that is, setProperty gets called with already set property name again).

  • Method Details

    • setProperty

      public void setProperty(String property)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the property to compare.

      If the property was the same as the current, the sort is reversed if "toggleAscendingOnProperty" is activated, else simply ignored.

      See Also:

    • getProperty

      public String getProperty()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SortDefinition
      Return the name of the bean property to compare. Can also be a nested bean property path.
      Specified by:
      getProperty in interface SortDefinition

    • setIgnoreCase

      public void setIgnoreCase(boolean ignoreCase)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set whether upper and lower case in String values should be ignored.

    • isIgnoreCase

      public boolean isIgnoreCase()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SortDefinition
      Return whether upper and lower case in String values should be ignored.
      Specified by:
      isIgnoreCase in interface SortDefinition

    • setAscending

      public void setAscending(boolean ascending)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set whether to sort ascending (true) or descending (false).

    • isAscending

      public boolean isAscending()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SortDefinition
      Return whether to sort ascending (true) or descending (false).
      Specified by:
      isAscending in interface SortDefinition

    • setToggleAscendingOnProperty

      public void setToggleAscendingOnProperty(boolean toggleAscendingOnProperty)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set whether to toggle the ascending flag if the same property gets set again (that is, setProperty(String) gets called with already set property name again).

      This is particularly useful for parameter binding through a web request, where clicking on the field header again might be supposed to trigger a resort for the same field but opposite order.

    • isToggleAscendingOnProperty

      public boolean isToggleAscendingOnProperty()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return whether to toggle the ascending flag if the same property gets set again (that is, setProperty gets called with already set property name again).

    • equals

      public boolean equals(@Nullable Object other)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object