程序包 ohos.utils

类 Scope<T extends Comparable<? super T>>

java.lang.Object

ohos.utils.Scope<T>

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

Describes the range of valid values for a field.

The lower bound of a range must be less than or equal to the upper bound of the range. This requires that the objects in a Scope must be comparable.

从以下版本开始:

1

构造器概要

构造器

构造器	说明
Scope(T lowerObj, T upperObj)	A constructor used to create a Scope instance with the lower and upper bounds specified.

方法概要

限定符和类型	方法	说明
T	clamp(T value)	Clamps a given value to the current range.
boolean	contains(Scope<T> range)	Checks whether a given range is within the current range.
boolean	contains(T value)	Checks whether a given value is within the current range.
static <T extends Comparable<? super T>> Scope<T>	create(T lowerObj, T upperObj)	Creates a range whose data type is the same as the input parameters.
boolean	equals(Object obj)	Checks whether a given object is equal to the current range.
Scope<T>	expand(Scope<T> range)	Creates the smallest range that includes the current range and a given range.
Scope<T>	expand(T value)	Creates the smallest range that includes the current range and a given value.
Scope<T>	expand(T lowerObj, T upperObj)	Creates the smallest range that includes the current range and the given lower and upper bounds.
T	getLower()	Obtains the lower bound of the current range.
T	getUpper()	Obtains the upper bound of the current range.
int	hashCode()	Obtains the hash code value of the current range.
Scope<T>	intersect(Scope<T> range)	Returns the intersection of a given range and the current range.
Scope<T>	intersect(T lowerObj, T upperObj)	Returns the intersection of the current range and the range specified by the given lower and upper bounds.
String	toString()	Obtains a string representation of the current range.

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

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

构造器详细资料

Scope

public Scope(T lowerObj,
             T upperObj)

A constructor used to create a Scope instance with the lower and upper bounds specified.

参数:

lowerObj - Indicates the lower bound of the Scope instance.

upperObj - Indicates the upper bound of the Scope instance.

抛出:

NullPointerException - Throws this exception if lowerObj or upperObj is null.

IllegalArgumentException - Throws this exception if lowerObj is bigger than upperObj.

从以下版本开始:

1

方法详细资料

create

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

Creates a range whose data type is the same as the input parameters.

The data type of input parameters must be comparable.

参数:

lowerObj - Indicates the lower bound of the Scope instance.

upperObj - Indicates the upper bound of the Scope instance.

抛出:

NullPointerException - Throws this exception if lowerObj or upperObj is null.

IllegalArgumentException - Throws this exception if lowerObj is bigger than upperObj.

从以下版本开始:

1

getLower

public T getLower()

Obtains the lower bound of the current range.

返回:

Returns the lower bound of the current range.

从以下版本开始:

1

getUpper

public T getUpper()

Obtains the upper bound of the current range.

返回:

Returns the upper bound of the current range.

从以下版本开始:

1

clamp

public T clamp(T value)

Clamps a given value to the current range.

The given value is returned if it is within the range. The lower bound is returned if the given value is less than the lower bound; and the upper bound is returned if the given value is greater than the upper bound.

参数:

value - Indicates the value to clamp.

返回:

Returns the value clamped to the current range.

抛出:

NullPointerException - Throws this exception if value is null.

从以下版本开始:

1

contains

public boolean contains(T value)

Checks whether a given value is within the current range.

A value is within a range if it is greater than or equal to the lower bound and less than or equal to the upper bound of the range.

参数:

value - Indicates the value to check.

返回:

Returns true if the given value is within the range; returns false otherwise.

抛出:

NullPointerException - Throws this exception if value is null.

从以下版本开始:

1

contains

public boolean contains(Scope<T> range)

Checks whether a given range is within the current range.

The given range is within the current range if its lower bound is greater than or equal to the lower bound of the current range and its upper bound is less than or equal to the upper bound of the current range.

参数:

range - Indicates the range to check.

返回:

Returns true if the given range is within the current range; returns false otherwise.

抛出:

NullPointerException - Throws this exception if range is null.

从以下版本开始:

1

expand

public Scope<T> expand(Scope<T> range)

Creates the smallest range that includes the current range and a given range.

The lower bound of the range to create is the smaller value between the lower bound of the current range and that of the given range. The upper bound of the range to create is the larger value between the upper bound of the current range and that of the given range.

参数:

range - Indicates the range used together with the current range to create their extension.

返回:

Returns the smallest range that includes the current range and the given range.

抛出:

NullPointerException - Throws this exception if range is null.

IllegalArgumentException - Throws this exception if lowerObj is bigger than upperObj.

从以下版本开始:

1

expand

public Scope<T> expand(T lowerObj,
                       T upperObj)

Creates the smallest range that includes the current range and the given lower and upper bounds.

The lower bound of the range to create is the smaller value between the lower bound of the current range and the given lower bound. The upper bound of the range to create is the larger value between the upper bound of the current range and the given upper bound.

参数:

lowerObj - Indicates the lower bound.

upperObj - Indicates the upper bound.

返回:

Returns the smallest range that includes the current range and the given lower and upper bounds.

抛出:

NullPointerException - Throws this exception if lowerObj or upperObj is null.

IllegalArgumentException - Throws this exception if lowerObj is bigger than upperObj.

从以下版本开始:

1

expand

public Scope<T> expand(T value)

Creates the smallest range that includes the current range and a given value.

The lower bound of the range to create is the smaller value between the lower bound of the current range and the given value. The upper bound of the range to create is the larger value between the upper bound of the current range and the given value.

参数:

value - Indicates the given value.

返回:

Returns the smallest range that includes the current range and the given value.

抛出:

NullPointerException - Throws this exception if value is null.

IllegalArgumentException - Throws this exception if lowerObj is bigger than upperObj.

从以下版本开始:

1

intersect

public Scope<T> intersect(Scope<T> range)

Returns the intersection of a given range and the current range.

参数:

range - Indicates the given range.

返回:

Returns the intersection.

抛出:

NullPointerException - Throws this exception if range is null.

IllegalArgumentException - Throws this exception if the two ranges have no intersection.

从以下版本开始:

1

intersect

public Scope<T> intersect(T lowerObj,
                          T upperObj)

Returns the intersection of the current range and the range specified by the given lower and upper bounds.

参数:

lowerObj - Indicates the lower bound.

upperObj - Indicates the upper bound.

返回:

Returns the intersection.

抛出:

NullPointerException - Throws this exception if lowerObj or upperObj is null.

IllegalArgumentException - Throws this exception if the two ranges have no intersection.

从以下版本开始:

1

equals

public boolean equals(Object obj)

Checks whether a given object is equal to the current range.

覆盖:

equals 在类中 Object

参数:

obj - Indicates the range object to compare.

返回:

Returns true if the given object is equal to the current range; returns false otherwise.

从以下版本开始:

1

另请参阅:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Obtains the hash code value of the current range.

覆盖:

hashCode 在类中 Object

返回:

Returns the hash code value of the current range.

从以下版本开始:

1

另请参阅:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Obtains a string representation of the current range.

覆盖:

toString 在类中 Object

返回:

Returns the string representation of the current range.

从以下版本开始:

1