鴻蒙OS Scope

Scope

java.lang.Object

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

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

描述字段的有效值范圍。

范圍的下限必須小于或等于范圍的上限。 這要求 Scope 中的對象必須是可比較的。

構(gòu)造函數(shù)摘要

構(gòu)造函數(shù)	描述
Scope(T lowerObj, T upperObj)	用于創(chuàng)建具有指定下限和上限的 Scope 實例的構(gòu)造函數(shù)。

方法總結(jié)

修飾符和類型	方法	描述
T	clamp(T value)	將給定值限制在當(dāng)前范圍內(nèi)。
boolean	contains(ScopeT range)	檢查給定范圍是否在當(dāng)前范圍內(nèi)。
boolean	contains(T value)	檢查給定值是否在當(dāng)前范圍內(nèi)。
static <T extends Comparable<? super T>>Scope<T>	create(T lowerObj, T upperObj)	創(chuàng)建一個數(shù)據(jù)類型與輸入?yún)?shù)相同的范圍。
boolean	equals(Object obj)	檢查給定對象是否等于當(dāng)前范圍。
ScopeT	expand(ScopeT range)	創(chuàng)建包含當(dāng)前范圍和給定范圍的最小范圍。
ScopeT	expand(T value)	創(chuàng)建包含當(dāng)前范圍和給定值的最小范圍。
ScopeT	expand(T lowerObj, T upperObj)	創(chuàng)建包含當(dāng)前范圍和給定下限和上限的最小范圍。
T	getLower()	獲取當(dāng)前范圍的下限。
T	getUpper()	獲取當(dāng)前范圍的上限。
int	hashCode()	獲取當(dāng)前范圍的哈希碼值。
ScopeT	intersect(ScopeT range)	返回給定范圍和當(dāng)前范圍的交集。
ScopeT	intersect(T lowerObj, T upperObj)	返回當(dāng)前范圍與給定下限和上限指定的范圍的交集。
String	toString()	獲取當(dāng)前范圍的字符串表示形式。

從類 java.lang.Object 繼承的方法
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

構(gòu)造函數(shù)詳細(xì)信息

Scope

public Scope(T lowerObj, T upperObj)

用于創(chuàng)建具有指定下限和上限的 Scope 實例的構(gòu)造函數(shù)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
lowerObj	表示 Scope 實例的下限。
upperObj	表示 Scope 實例的上限。

Throws:

Throw名稱	Throw描述
NullPointerException	如果 lowerObj 或 upperObj 為 null，則引發(fā)此異常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，則拋出此異常。

方法詳情

create

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

創(chuàng)建一個數(shù)據(jù)類型與輸入?yún)?shù)相同的范圍。

輸入?yún)?shù)的數(shù)據(jù)類型必須具有可比性。

參數(shù)：

參數(shù)名稱	參數(shù)描述
lowerObj	表示 Scope 實例的下限。
upperObj	表示 Scope 實例的上限。

Throws:

Throw名稱	Throw描述
NullPointerException	如果 lowerObj 或 upperObj 為 null，則引發(fā)此異常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，則拋出此異常。

getLower

public T getLower()

獲取當(dāng)前范圍的下限。

返回:

返回當(dāng)前范圍的下限。

getUpper

public T getUpper()

獲取當(dāng)前范圍的上限。

返回:

返回當(dāng)前范圍的上限。

clamp

public T clamp(T value)

將給定值限制在當(dāng)前范圍內(nèi)。

如果給定值在范圍內(nèi)，則返回給定值。 如果給定值小于下限，則返回下限； 如果給定值大于上限，則返回上限。

參數(shù)：

參數(shù)名稱	參數(shù)描述
value	指示要鉗位的值。

返回:

返回限制在當(dāng)前范圍內(nèi)的值。

Throws:

Throw名稱	Throw描述
NullPointerException	如果值為 null，則引發(fā)此異常。

contains

public boolean contains(T value)

檢查給定值是否在當(dāng)前范圍內(nèi)。

如果值大于或等于范圍的下限且小于或等于范圍的上限，則該值在范圍內(nèi)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
value	指示要檢查的值。

返回:

如果給定值在范圍內(nèi)，則返回 true； 否則返回 false。

Throws:

Throw名稱	Throw描述
NullPointerException	如果值為 null，則引發(fā)此異常。

contains

public boolean contains(ScopeT range)

檢查給定范圍是否在當(dāng)前范圍內(nèi)。

如果給定范圍的下限大于或等于當(dāng)前范圍的下限并且其上限小于或等于當(dāng)前范圍的上限，則給定范圍在當(dāng)前范圍內(nèi)。

參數(shù)：

參數(shù)名稱	參數(shù)描述
range	表示要檢查的范圍。

返回:

如果給定范圍在當(dāng)前范圍內(nèi)，則返回 true； 否則返回 false。

Throws:

Throw名稱	Throw描述
NullPointerException	如果范圍為空，則引發(fā)此異常。

expand

public ScopeT expand(ScopeT range)

創(chuàng)建包含當(dāng)前范圍和給定范圍的最小范圍。

要創(chuàng)建的范圍的下限是當(dāng)前范圍的下限和給定范圍的下限之間的較小值。 要創(chuàng)建的范圍的上限是當(dāng)前范圍的上限和給定范圍的上限之間的較大值。

參數(shù)：

參數(shù)名稱	參數(shù)描述
range	指示與當(dāng)前范圍一起使用以創(chuàng)建其擴(kuò)展的范圍。

返回:

返回包含當(dāng)前范圍和給定范圍的最小范圍。

Throws:

Throw名稱	Throw描述
NullPointerException	如果范圍為空，則引發(fā)此異常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，則拋出此異常。

expand

public ScopeT expand(T lowerObj, T upperObj)

創(chuàng)建包含當(dāng)前范圍和給定下限和上限的最小范圍。

要創(chuàng)建的范圍的下限是當(dāng)前范圍的下限和給定的下限之間的較小值。 要創(chuàng)建的范圍的上限是當(dāng)前范圍的上限和給定的上限之間的較大值。

參數(shù)：

參數(shù)名稱	參數(shù)描述
lowerObj	表示下限。
upperObj	表示上限。

返回:

返回包含當(dāng)前范圍和給定下限和上限的最小范圍。

Throws:

Throw名稱	Throw描述
NullPointerException	如果 lowerObj 或 upperObj 為 null，則引發(fā)此異常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，則拋出此異常。

expand

public ScopeT expand(T value)

創(chuàng)建包含當(dāng)前范圍和給定值的最小范圍。

要創(chuàng)建的范圍的下限是當(dāng)前范圍的下限和給定值之間的較小值。 要創(chuàng)建的范圍的上限是當(dāng)前范圍的上限和給定值之間的較大值。

參數(shù)：

參數(shù)名稱	參數(shù)描述
value	表示給定值。

返回:

返回包含當(dāng)前范圍和給定值的最小范圍。

Throws:

Throw名稱	Throw描述
NullPointerException	如果值為 null，則引發(fā)此異常。
IllegalArgumentException	如果 lowerObj 大于 upperObj，則拋出此異常。

intersect

public ScopeT intersect(ScopeT range)

返回給定范圍和當(dāng)前范圍的交集。

參數(shù)：

參數(shù)名稱	參數(shù)描述
range	表示給定范圍。

返回:

返回交點。

Throws:

Throw名稱	Throw描述
NullPointerException	如果范圍為空，則引發(fā)此異常。
IllegalArgumentException	如果兩個范圍沒有交集，則拋出此異常。

intersect

public ScopeT intersect(T lowerObj, T upperObj)

返回當(dāng)前范圍與給定下限和上限指定的范圍的交集。

參數(shù)：

參數(shù)名稱	參數(shù)描述
lowerObj	表示下限。
upperObj	表示上限。

返回:

返回交點。

Throws:

Throw名稱	Throw描述
NullPointerException	如果 lowerObj 或 upperObj 為 null，則引發(fā)此異常。
IllegalArgumentException	如果兩個范圍沒有交集，則拋出此異常。

equals

public boolean equals(Object obj)

檢查給定對象是否等于當(dāng)前范圍。

覆蓋：

類 Object 中的等于

參數(shù)：

參數(shù)名稱	參數(shù)描述
obj	指示要比較的范圍對象。

返回:

如果給定對象等于當(dāng)前范圍，則返回 true； 否則返回 false。

hashCode

public int hashCode()

獲取當(dāng)前范圍的哈希碼值。

覆蓋：

類 Object 中的 hashCode

返回:

返回當(dāng)前范圍的哈希碼值。

toString

public String toString()

獲取當(dāng)前范圍的字符串表示形式。

覆蓋：

類 Object 中的 toString

返回:

返回當(dāng)前范圍的字符串表示形式。