Class MutableSortDefinition
java.lang.Object
org.springframework.beans.support.MutableSortDefinition
- All Implemented Interfaces:
Serializable,SortDefinition
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
ConstructorsConstructorDescriptionCreate an empty MutableSortDefinition, to be populated via its bean properties.MutableSortDefinition(boolean toggleAscendingOnSameProperty) Create a new MutableSortDefinition.MutableSortDefinition(String property, boolean ignoreCase, boolean ascending) Create a MutableSortDefinition for the given settings.MutableSortDefinition(SortDefinition source) Copy constructor: create a new MutableSortDefinition that mirrors the given sort definition. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturn the name of the bean property to compare.inthashCode()booleanReturn whether to sort ascending (true) or descending (false).booleanReturn whether upper and lower case in String values should be ignored.booleanReturn whether to toggle the ascending flag if the same property gets set again (that is,setPropertygets called with already set property name again).voidsetAscending(boolean ascending) Set whether to sort ascending (true) or descending (false).voidsetIgnoreCase(boolean ignoreCase) Set whether upper and lower case in String values should be ignored.voidsetProperty(String property) Set the property to compare.voidsetToggleAscendingOnProperty(boolean toggleAscendingOnProperty) Set whether to toggle the ascending flag if the same property gets set again (that is,setProperty(java.lang.String)gets called with already set property name again).
-
Constructor Details
-
MutableSortDefinition
public MutableSortDefinition()Create an empty MutableSortDefinition, to be populated via its bean properties. -
MutableSortDefinition
Copy constructor: create a new MutableSortDefinition that mirrors the given sort definition.- Parameters:
source- the original sort definition
-
MutableSortDefinition
Create a MutableSortDefinition for the given settings.- Parameters:
property- the property to compareignoreCase- whether upper and lower case in String values should be ignoredascending- whether to sort ascending (true) or descending (false)
-
MutableSortDefinition
public MutableSortDefinition(boolean toggleAscendingOnSameProperty) Create a new MutableSortDefinition.- Parameters:
toggleAscendingOnSameProperty- whether to toggle the ascending flag if the same property gets set again (that is,setPropertygets called with already set property name again).
-
-
Method Details
-
setProperty
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
Description copied from interface:SortDefinitionReturn the name of the bean property to compare. Can also be a nested bean property path.- Specified by:
getPropertyin interfaceSortDefinition
-
setIgnoreCase
public void setIgnoreCase(boolean ignoreCase) Set whether upper and lower case in String values should be ignored. -
isIgnoreCase
public boolean isIgnoreCase()Description copied from interface:SortDefinitionReturn whether upper and lower case in String values should be ignored.- Specified by:
isIgnoreCasein interfaceSortDefinition
-
setAscending
public void setAscending(boolean ascending) Set whether to sort ascending (true) or descending (false). -
isAscending
public boolean isAscending()Description copied from interface:SortDefinitionReturn whether to sort ascending (true) or descending (false).- Specified by:
isAscendingin interfaceSortDefinition
-
setToggleAscendingOnProperty
public void setToggleAscendingOnProperty(boolean toggleAscendingOnProperty) Set whether to toggle the ascending flag if the same property gets set again (that is,setProperty(java.lang.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()Return whether to toggle the ascending flag if the same property gets set again (that is,setPropertygets called with already set property name again). -
equals
-
hashCode
public int hashCode()
-