cn.hutool.core.comparator

类 ComparatorChain<E>

java.lang.Object

cn.hutool.core.comparator.ComparatorChain<E>

所有已实现的接口:

Chain<Comparator<E>,ComparatorChain<E>>, Serializable, Iterable<Comparator<E>>, Comparator<E>

public class ComparatorChain<E>
extends Object
implements Chain<Comparator<E>,ComparatorChain<E>>, Comparator<E>, Serializable

比较器链。此链包装了多个比较器，最终比较结果按照比较器顺序综合多个比较器结果。
按照比较器链的顺序分别比较，如果比较出相等则转向下一个比较器，否则直接返回
此类copy from Apache-commons-collections

从以下版本开始:

3.0.7

作者:

looly

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
ComparatorChain() 构造空的比较器链，必须至少有一个比较器，否则会在compare时抛出UnsupportedOperationException
ComparatorChain(Comparator<E> comparator) 构造，初始化单一比较器。
ComparatorChain(Comparator<E> comparator, boolean reverse) 构造，初始化单一比较器。
ComparatorChain(List<Comparator<E>> list) 构造，使用已有的比较器列表
ComparatorChain(List<Comparator<E>> list, BitSet bits) 构造，使用已有的比较器列表和对应的BitSet BitSet中的boolean值需与list中的Comparator一一对应，true表示正序，false反序

方法概要

方法

限定符和类型	方法和说明
ComparatorChain<E>	addChain(Comparator<E> element) 加入责任链
ComparatorChain<E>	addComparator(Comparator<E> comparator) 在链的尾部添加比较器，使用正向排序
ComparatorChain<E>	addComparator(Comparator<E> comparator, boolean reverse) 在链的尾部添加比较器，使用给定排序方式
int	compare(E o1, E o2) 执行比较 按照比较器链的顺序分别比较，如果比较出相等则转向下一个比较器，否则直接返回
boolean	equals(Object object)
int	hashCode()
boolean	isLocked() 是否已经被锁定。
Iterator<Comparator<E>>	iterator()
ComparatorChain<E>	setComparator(int index, Comparator<E> comparator) 替换指定位置的比较器，保持原排序方式
ComparatorChain<E>	setComparator(int index, Comparator<E> comparator, boolean reverse) 替换指定位置的比较器，替换指定排序方式
ComparatorChain<E>	setForwardSort(int index) 更改指定位置的排序方式为正序
ComparatorChain<E>	setReverseSort(int index) 更改指定位置的排序方式为反序
int	size() 比较器链中比较器个数

从类继承的方法 java.lang.Object

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

构造器详细资料

ComparatorChain

public ComparatorChain()

构造空的比较器链，必须至少有一个比较器，否则会在compare时抛出UnsupportedOperationException

ComparatorChain

public ComparatorChain(Comparator<E> comparator)

构造，初始化单一比较器。比较器为正序

参数:

comparator - 在比较器链中的第一个比较器

ComparatorChain

public ComparatorChain(Comparator<E> comparator,
               boolean reverse)

构造，初始化单一比较器。自定义正序还是反序

参数:

comparator - 在比较器链中的第一个比较器

reverse - 是否反序，true表示反序，false正序

ComparatorChain

public ComparatorChain(List<Comparator<E>> list)

构造，使用已有的比较器列表

参数:

list - 比较器列表

另请参阅:

ComparatorChain(List,BitSet)

ComparatorChain

public ComparatorChain(List<Comparator<E>> list,
               BitSet bits)

构造，使用已有的比较器列表和对应的BitSet
BitSet中的boolean值需与list中的Comparator一一对应，true表示正序，false反序

参数:

list - Comparator 列表

bits - Comparator 列表对应的排序boolean值，true表示正序，false反序

方法详细资料

addComparator

public ComparatorChain<E> addComparator(Comparator<E> comparator)

在链的尾部添加比较器，使用正向排序

参数:

comparator - Comparator 比较器，正向

返回:

this

addComparator

public ComparatorChain<E> addComparator(Comparator<E> comparator,
                               boolean reverse)

在链的尾部添加比较器，使用给定排序方式

参数:

comparator - Comparator 比较器

reverse - 是否反序，true表示正序，false反序

返回:

this

setComparator

public ComparatorChain<E> setComparator(int index,
                               Comparator<E> comparator)
                                 throws IndexOutOfBoundsException

替换指定位置的比较器，保持原排序方式

参数:

index - 位置

comparator - Comparator

返回:

this

抛出:

IndexOutOfBoundsException - if index < 0 or index >= size()

setComparator

public ComparatorChain<E> setComparator(int index,
                               Comparator<E> comparator,
                               boolean reverse)

替换指定位置的比较器，替换指定排序方式

参数:

index - 位置

comparator - Comparator

reverse - 是否反序，true表示正序，false反序

返回:

this

setForwardSort

public ComparatorChain<E> setForwardSort(int index)

更改指定位置的排序方式为正序

参数:

index - 位置

返回:

this

setReverseSort

public ComparatorChain<E> setReverseSort(int index)

更改指定位置的排序方式为反序

参数:

index - 位置

返回:

this

size

public int size()

比较器链中比较器个数

返回:

Comparator count

isLocked

public boolean isLocked()

是否已经被锁定。当开始比较时（调用compare方法）此值为true

返回:

true = ComparatorChain cannot be modified; false = ComparatorChain can still be modified.

iterator

public Iterator<Comparator<E>> iterator()

指定者:

iterator 在接口中 Iterable<Comparator<E>>

addChain

public ComparatorChain<E> addChain(Comparator<E> element)

从接口复制的说明: Chain

加入责任链

指定者:

addChain 在接口中 Chain<Comparator<E>,ComparatorChain<E>>

参数:

element - 责任链新的环节元素

返回:

this

compare

public int compare(E o1,
          E o2)
            throws UnsupportedOperationException

执行比较
按照比较器链的顺序分别比较，如果比较出相等则转向下一个比较器，否则直接返回

指定者:

compare 在接口中 Comparator<E>

参数:

o1 - 第一个对象

o2 - 第二个对象

返回:

-1, 0, or 1

抛出:

UnsupportedOperationException - 如果比较器链为空，无法完成比较

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

equals

public boolean equals(Object object)

指定者:

equals 在接口中 Comparator<E>

覆盖:

equals 在类中 Object