Top Description Fields Constructors Methods
org.springframework.beans.support

public Class MutableSortDefinition

extends Object
implements SortDefinition, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.springframework.beans.support.SortDefinition
Annotations
@SuppressWarnings:serial
Imports
java.io.Serializable, org.springframework.lang.Nullable, org.springframework.util.StringUtils

Mutable implementation of the SortDefinition interface. Supports toggling the ascending value on setting the same property again.
Authors
Juergen Hoeller, Jean-Pierre Pawlak
Since
26.05.2003
See Also
setToggleAscendingOnProperty

Field Summary

Modifier and TypeField and Description
private boolean
private boolean
private String
private boolean

Constructor Summary

AccessConstructor and Description
public
MutableSortDefinition()

Create an empty MutableSortDefinition, to be populated via its bean properties.

public
MutableSortDefinition(SortDefinition
the original sort definition
source
)

Copy constructor: create a new MutableSortDefinition that mirrors the given sort definition.

public
MutableSortDefinition(String
the property to compare
property
,
boolean
whether upper and lower case in String values should be ignored
ignoreCase
,
boolean
whether to sort ascending (true) or descending (false)
ascending
)

Create a MutableSortDefinition for the given settings.

public
MutableSortDefinition(boolean
whether to toggle the ascending flag if the same property gets set again (that is, setProperty gets called with already set property name again).
toggleAscendingOnSameProperty
)

Create a new MutableSortDefinition.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String
getProperty()

Implements org.springframework.beans.support.SortDefinition.getProperty.

Return the name of the bean property to compare.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isAscending()

Implements org.springframework.beans.support.SortDefinition.isAscending.

Return whether to sort ascending (true) or descending (false).

public boolean
isIgnoreCase()

Implements org.springframework.beans.support.SortDefinition.isIgnoreCase.

Return whether upper and lower case in String values should be ignored.

public boolean
isToggleAscendingOnProperty()

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).

public void
setAscending(boolean ascending)

Set whether to sort ascending (true) or descending (false).

public void
setIgnoreCase(boolean ignoreCase)

Set whether upper and lower case in String values should be ignored.

public void
setProperty(String property)

Set the property to compare.

public void
setToggleAscendingOnProperty(boolean toggleAscendingOnProperty)

Set whether to toggle the ascending flag if the same property gets set again (that is, setProperty gets called with already set property name again).

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

ascendingback to summary
private boolean ascending
ignoreCaseback to summary
private boolean ignoreCase
propertyback to summary
private String property
toggleAscendingOnPropertyback to summary
private boolean toggleAscendingOnProperty

Constructor Detail

MutableSortDefinitionback to summary
public MutableSortDefinition()

Create an empty MutableSortDefinition, to be populated via its bean properties.

See Also
setProperty, setIgnoreCase, setAscending
MutableSortDefinitionback to summary
public MutableSortDefinition(SortDefinition source)

Copy constructor: create a new MutableSortDefinition that mirrors the given sort definition.

Parameters
source:SortDefinition

the original sort definition

MutableSortDefinitionback to summary
public MutableSortDefinition(String property, boolean ignoreCase, boolean ascending)

Create a MutableSortDefinition for the given settings.

Parameters
property:String

the property to compare

ignoreCase:boolean

whether upper and lower case in String values should be ignored

ascending:boolean

whether to sort ascending (true) or descending (false)

MutableSortDefinitionback to summary
public MutableSortDefinition(boolean toggleAscendingOnSameProperty)

Create a new MutableSortDefinition.

Parameters
toggleAscendingOnSameProperty:boolean

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 Detail

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getPropertyback to summary
public String getProperty()

Implements org.springframework.beans.support.SortDefinition.getProperty.

Doc from org.springframework.beans.support.SortDefinition.getProperty.

Return the name of the bean property to compare. Can also be a nested bean property path.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isAscendingback to summary
public boolean isAscending()

Implements org.springframework.beans.support.SortDefinition.isAscending.

Doc from org.springframework.beans.support.SortDefinition.isAscending.

Return whether to sort ascending (true) or descending (false).

Annotations
@Override
isIgnoreCaseback to summary
public boolean isIgnoreCase()

Implements org.springframework.beans.support.SortDefinition.isIgnoreCase.

Doc from org.springframework.beans.support.SortDefinition.isIgnoreCase.

Return whether upper and lower case in String values should be ignored.

Annotations
@Override
isToggleAscendingOnPropertyback to summary
public boolean isToggleAscendingOnProperty()

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).

setAscendingback to summary
public void setAscending(boolean ascending)

Set whether to sort ascending (true) or descending (false).

setIgnoreCaseback to summary
public void setIgnoreCase(boolean ignoreCase)

Set whether upper and lower case in String values should be ignored.

setPropertyback to summary
public void setProperty(String property)

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
setToggleAscendingOnProperty
setToggleAscendingOnPropertyback to summary
public void setToggleAscendingOnProperty(boolean toggleAscendingOnProperty)

Set whether to toggle the ascending flag if the same property gets set again (that is, setProperty 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.