鸿蒙OS Scope

Scope

java.lang.Object

|---ohos.utils.Scope<T&

public final class Scope<T extends Comparable<? super T>>
extends Object

描述字段的有效值范围。

范围的下限必须小于或等于范围的上限。 这要求 Scope 中的对象必须是可比较的。

构造函数摘要

构造函数	描述
Scope(T lowerObj, T upperObj)	用于创建具有指定下限和上限的 Scope 实例的构造函数。

方法总结

修饰符和类型	方法	描述
T	clamp(T value)	将给定值限制在当前范围内。
boolean	contains(ScopeT range)	检查给定范围是否在当前范围内。
boolean	contains(T value)	检查给定值是否在当前范围内。
static <T extends Comparable<? super T>>Scope<T>	create(T lowerObj, T upperObj)	创建一个数据类型与输入参数相同的范围。
boolean	equals(Object obj)	检查给定对象是否等于当前范围。
ScopeT	expand(ScopeT range)	创建包含当前范围和给定范围的最小范围。
ScopeT	expand(T value)	创建包含当前范围和给定值的最小范围。
ScopeT	expand(T lowerObj, T upperObj)	创建包含当前范围和给定下限和上限的最小范围。
T	getLower()	获取当前范围的下限。
T	getUpper()	获取当前范围的上限。
int	hashCode()	获取当前范围的哈希码值。
ScopeT	intersect(ScopeT range)	返回给定范围和当前范围的交集。
ScopeT	intersect(T lowerObj, T upperObj)	返回当前范围与给定下限和上限指定的范围的交集。
String	toString()	获取当前范围的字符串表示形式。

从类 java.lang.Object 继承的方法
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造函数详细信息

Scope

public Scope(T lowerObj, T upperObj)

用于创建具有指定下限和上限的 Scope 实例的构造函数。

参数：

参数名称	参数描述
lowerObj	表示 Scope 实例的下限。
upperObj	表示 Scope 实例的上限。

Throws:

Throw名称	Throw描述
NullPointerException	如果 lowerObj 或 upperObj 为 null，则引发此异常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，则抛出此异常。

方法详情

create

public static <T extends Comparable<? super T>> Scope<T> create(T lowerObj, T upperObj)

创建一个数据类型与输入参数相同的范围。

输入参数的数据类型必须具有可比性。

参数：

参数名称	参数描述
lowerObj	表示 Scope 实例的下限。
upperObj	表示 Scope 实例的上限。

Throws:

Throw名称	Throw描述
NullPointerException	如果 lowerObj 或 upperObj 为 null，则引发此异常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，则抛出此异常。

getLower

public T getLower()

获取当前范围的下限。

返回:

返回当前范围的下限。

getUpper

public T getUpper()

获取当前范围的上限。

返回:

返回当前范围的上限。

clamp

public T clamp(T value)

将给定值限制在当前范围内。

如果给定值在范围内，则返回给定值。 如果给定值小于下限，则返回下限； 如果给定值大于上限，则返回上限。

参数：

参数名称	参数描述
value	指示要钳位的值。

返回:

返回限制在当前范围内的值。

Throws:

Throw名称	Throw描述
NullPointerException	如果值为 null，则引发此异常。

contains

public boolean contains(T value)

检查给定值是否在当前范围内。

如果值大于或等于范围的下限且小于或等于范围的上限，则该值在范围内。

参数：

参数名称	参数描述
value	指示要检查的值。

返回:

如果给定值在范围内，则返回 true； 否则返回 false。

Throws:

Throw名称	Throw描述
NullPointerException	如果值为 null，则引发此异常。

contains

public boolean contains(ScopeT range)

检查给定范围是否在当前范围内。

如果给定范围的下限大于或等于当前范围的下限并且其上限小于或等于当前范围的上限，则给定范围在当前范围内。

参数：

参数名称	参数描述
range	表示要检查的范围。

返回:

如果给定范围在当前范围内，则返回 true； 否则返回 false。

Throws:

Throw名称	Throw描述
NullPointerException	如果范围为空，则引发此异常。

expand

public ScopeT expand(ScopeT range)

创建包含当前范围和给定范围的最小范围。

要创建的范围的下限是当前范围的下限和给定范围的下限之间的较小值。 要创建的范围的上限是当前范围的上限和给定范围的上限之间的较大值。

参数：

参数名称	参数描述
range	指示与当前范围一起使用以创建其扩展的范围。

返回:

返回包含当前范围和给定范围的最小范围。

Throws:

Throw名称	Throw描述
NullPointerException	如果范围为空，则引发此异常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，则抛出此异常。

expand

public ScopeT expand(T lowerObj, T upperObj)

创建包含当前范围和给定下限和上限的最小范围。

要创建的范围的下限是当前范围的下限和给定的下限之间的较小值。 要创建的范围的上限是当前范围的上限和给定的上限之间的较大值。

参数：

参数名称	参数描述
lowerObj	表示下限。
upperObj	表示上限。

返回:

返回包含当前范围和给定下限和上限的最小范围。

Throws:

Throw名称	Throw描述
NullPointerException	如果 lowerObj 或 upperObj 为 null，则引发此异常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，则抛出此异常。

expand

public ScopeT expand(T value)

创建包含当前范围和给定值的最小范围。

要创建的范围的下限是当前范围的下限和给定值之间的较小值。 要创建的范围的上限是当前范围的上限和给定值之间的较大值。

参数：

参数名称	参数描述
value	表示给定值。

返回:

返回包含当前范围和给定值的最小范围。

Throws:

Throw名称	Throw描述
NullPointerException	如果值为 null，则引发此异常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，则抛出此异常。

intersect

public ScopeT intersect(ScopeT range)

返回给定范围和当前范围的交集。

参数：

参数名称	参数描述
range	表示给定范围。

返回:

返回交点。

Throws:

Throw名称	Throw描述
NullPointerException	如果范围为空，则引发此异常。
IllegalArgumentException	如果两个范围没有交集，则抛出此异常。

intersect

public ScopeT intersect(T lowerObj, T upperObj)

返回当前范围与给定下限和上限指定的范围的交集。

参数：

参数名称	参数描述
lowerObj	表示下限。
upperObj	表示上限。

返回:

返回交点。

Throws:

Throw名称	Throw描述
NullPointerException	如果 lowerObj 或 upperObj 为 null，则引发此异常。
IllegalArgumentException	如果两个范围没有交集，则抛出此异常。

equals

public boolean equals(Object obj)

检查给定对象是否等于当前范围。

覆盖：

类 Object 中的等于

参数：

参数名称	参数描述
obj	指示要比较的范围对象。

返回:

如果给定对象等于当前范围，则返回 true； 否则返回 false。

hashCode

public int hashCode()

获取当前范围的哈希码值。

覆盖：

类 Object 中的 hashCode

返回:

返回当前范围的哈希码值。

toString

public String toString()

获取当前范围的字符串表示形式。

覆盖：

类 Object 中的 toString

返回:

返回当前范围的字符串表示形式。