UnicodeSetSpanner

java.lang.Object
- ohos.global.icu.text.UnicodeSetSpanner

```
public class UnicodeSetSpanner
extends Object
```
A helper class used to count, replace, and trim CharSequences based on UnicodeSet matches. An instance is immutable (and thus thread-safe) iff the source UnicodeSet is frozen.
Note: The counting, deletion, and replacement depend on alternating a SpanCondition with its inverse. That is, the code spans, then spans for the inverse, then spans, and so on. For the inverse, the following mapping is used:
These are actually not complete inverses. However, the alternating works because there are no gaps. For example, with [a{ab}{bc}], you get the following behavior when scanning forward:

SIMPLE xxx[ab]cyyy

CONTAINED xxx[abc]yyy

NOT_CONTAINED [xxx]ab[cyyy]

So here is what happens when you alternate:

start |xxxabcyyy

NOT_CONTAINED xxx|abcyyy

CONTAINED xxxabc|yyy

NOT_CONTAINED xxxabcyyy|

The entire string is traversed.

SIMPLE	xxx[ab]cyyy
CONTAINED	xxx[abc]yyy
NOT_CONTAINED	[xxx]ab[cyyy]

start	\|xxxabcyyy
NOT_CONTAINED	xxx\|abcyyy
CONTAINED	xxxabc\|yyy
NOT_CONTAINED	xxxabcyyy\|

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`UnicodeSetSpanner.CountMethod`	Options for replaceFrom and countIn to control how to treat each matched span.
`static class`	`UnicodeSetSpanner.TrimOption`	Options for the trim() method

构造器概要

构造器
构造器说明

UnicodeSetSpanner(UnicodeSet source)
Create a spanner from a UnicodeSet.

构造器
构造器	说明
`UnicodeSetSpanner(UnicodeSet source)`	Create a spanner from a UnicodeSet.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`int`	`countIn(CharSequence sequence)`	Returns the number of matching characters found in a character sequence, counting by CountMethod.MIN_ELEMENTS using SpanCondition.SIMPLE.
`int`	`countIn(CharSequence sequence, UnicodeSetSpanner.CountMethod countMethod)`	Returns the number of matching characters found in a character sequence, using SpanCondition.SIMPLE.
`int`	`countIn(CharSequence sequence, UnicodeSetSpanner.CountMethod countMethod, UnicodeSet.SpanCondition spanCondition)`	Returns the number of matching characters found in a character sequence.
`String`	`deleteFrom(CharSequence sequence)`	Delete all the matching spans in sequence, using SpanCondition.SIMPLE The code alternates spans; see the class doc for `UnicodeSetSpanner` for a note about boundary conditions.
`String`	`deleteFrom(CharSequence sequence, UnicodeSet.SpanCondition spanCondition)`	Delete all matching spans in sequence, according to the spanCondition.
`boolean`	`equals(Object other)`	Indicates whether some other object is "equal to" this one.
`UnicodeSet`	`getUnicodeSet()`	Returns the UnicodeSet used for processing.
`int`	`hashCode()`	Returns a hash code value for the object.
`String`	`replaceFrom(CharSequence sequence, CharSequence replacement)`	Replace all matching spans in sequence by the replacement, counting by CountMethod.MIN_ELEMENTS using SpanCondition.SIMPLE.
`String`	`replaceFrom(CharSequence sequence, CharSequence replacement, UnicodeSetSpanner.CountMethod countMethod)`	Replace all matching spans in sequence by replacement, according to the CountMethod, using SpanCondition.SIMPLE.
`String`	`replaceFrom(CharSequence sequence, CharSequence replacement, UnicodeSetSpanner.CountMethod countMethod, UnicodeSet.SpanCondition spanCondition)`	Replace all matching spans in sequence by replacement, according to the countMethod and spanCondition.
`CharSequence`	`trim(CharSequence sequence)`	Returns a trimmed sequence (using CharSequence.subsequence()), that omits matching elements at the start and end of the string, using TrimOption.BOTH and SpanCondition.SIMPLE.
`CharSequence`	`trim(CharSequence sequence, UnicodeSetSpanner.TrimOption trimOption)`	Returns a trimmed sequence (using CharSequence.subsequence()), that omits matching elements at the start or end of the string, using the trimOption and SpanCondition.SIMPLE.
`CharSequence`	`trim(CharSequence sequence, UnicodeSetSpanner.TrimOption trimOption, UnicodeSet.SpanCondition spanCondition)`	Returns a trimmed sequence (using CharSequence.subsequence()), that omits matching elements at the start or end of the string, depending on the trimOption and spanCondition.

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

- 构造器详细资料
  - UnicodeSetSpanner
```
public UnicodeSetSpanner(UnicodeSet source)
```
    Create a spanner from a UnicodeSet. For speed and safety, the UnicodeSet should be frozen. However, this class can be used with a non-frozen version to avoid the cost of freezing.
    
    参数:
    
    source - the original UnicodeSet
- 方法详细资料
  - getUnicodeSet
```
public UnicodeSet getUnicodeSet()
```
    Returns the UnicodeSet used for processing. It is frozen iff the original was.
    
    返回:
    
    the construction set.
  - equals
```
public boolean equals(Object other)
```
    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.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    other - the reference object with which to compare.
    
    返回:
    
    true if this object is the same as the obj argument; false otherwise.
    
    另请参阅:
    
    Object.hashCode(), HashMap
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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 Object.equals(java.lang.Object) 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.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    a hash code value for this object.
    
    另请参阅:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - countIn
```
public int countIn(CharSequence sequence)
```
    Returns the number of matching characters found in a character sequence, counting by CountMethod.MIN_ELEMENTS using SpanCondition.SIMPLE. The code alternates spans; see the class doc for UnicodeSetSpanner for a note about boundary conditions.
    
    参数:
    
    sequence - the sequence to count characters in
    
    返回:
    
    the count. Zero if there are none.
  - countIn
```
public int countIn(CharSequence sequence,
                   UnicodeSetSpanner.CountMethod countMethod)
```
    Returns the number of matching characters found in a character sequence, using SpanCondition.SIMPLE. The code alternates spans; see the class doc for UnicodeSetSpanner for a note about boundary conditions.
    
    参数:
    
    sequence - the sequence to count characters in
    
    countMethod - whether to treat an entire span as a match, or individual elements as matches
    
    返回:
    
    the count. Zero if there are none.
  - countIn
```
public int countIn(CharSequence sequence,
                   UnicodeSetSpanner.CountMethod countMethod,
                   UnicodeSet.SpanCondition spanCondition)
```
    Returns the number of matching characters found in a character sequence. The code alternates spans; see the class doc for UnicodeSetSpanner for a note about boundary conditions.
    
    参数:
    
    sequence - the sequence to count characters in
    
    countMethod - whether to treat an entire span as a match, or individual elements as matches
    
    spanCondition - the spanCondition to use. SIMPLE or CONTAINED means only count the elements in the span; NOT_CONTAINED is the reverse.
    WARNING: when a UnicodeSet contains strings, there may be unexpected behavior in edge cases.
    
    返回:
    
    the count. Zero if there are none.
  - deleteFrom
```
public String deleteFrom(CharSequence sequence)
```
    Delete all the matching spans in sequence, using SpanCondition.SIMPLE The code alternates spans; see the class doc for UnicodeSetSpanner for a note about boundary conditions.
    
    参数:
    
    sequence - charsequence to replace matching spans in.
    
    返回:
    
    modified string.
  - deleteFrom
```
public String deleteFrom(CharSequence sequence,
                         UnicodeSet.SpanCondition spanCondition)
```
    Delete all matching spans in sequence, according to the spanCondition. The code alternates spans; see the class doc for UnicodeSetSpanner for a note about boundary conditions.
    
    参数:
    
    sequence - charsequence to replace matching spans in.
    
    spanCondition - specify whether to modify the matching spans (CONTAINED or SIMPLE) or the non-matching (NOT_CONTAINED)
    
    返回:
    
    modified string.
  - replaceFrom
```
public String replaceFrom(CharSequence sequence,
                          CharSequence replacement)
```
    Replace all matching spans in sequence by the replacement, counting by CountMethod.MIN_ELEMENTS using SpanCondition.SIMPLE. The code alternates spans; see the class doc for UnicodeSetSpanner for a note about boundary conditions.
    
    参数:
    
    sequence - charsequence to replace matching spans in.
    
    replacement - replacement sequence. To delete, use ""
    
    返回:
    
    modified string.
  - replaceFrom
```
public String replaceFrom(CharSequence sequence,
                          CharSequence replacement,
                          UnicodeSetSpanner.CountMethod countMethod)
```
    Replace all matching spans in sequence by replacement, according to the CountMethod, using SpanCondition.SIMPLE. The code alternates spans; see the class doc for UnicodeSetSpanner for a note about boundary conditions.
    
    参数:
    
    sequence - charsequence to replace matching spans in.
    
    replacement - replacement sequence. To delete, use ""
    
    countMethod - whether to treat an entire span as a match, or individual elements as matches
    
    返回:
    
    modified string.
  - replaceFrom
```
public String replaceFrom(CharSequence sequence,
                          CharSequence replacement,
                          UnicodeSetSpanner.CountMethod countMethod,
                          UnicodeSet.SpanCondition spanCondition)
```
    Replace all matching spans in sequence by replacement, according to the countMethod and spanCondition. The code alternates spans; see the class doc for UnicodeSetSpanner for a note about boundary conditions.
    
    参数:
    
    sequence - charsequence to replace matching spans in.
    
    replacement - replacement sequence. To delete, use ""
    
    countMethod - whether to treat an entire span as a match, or individual elements as matches
    
    spanCondition - specify whether to modify the matching spans (CONTAINED or SIMPLE) or the non-matching (NOT_CONTAINED)
    
    返回:
    
    modified string.
  - trim
```
public CharSequence trim(CharSequence sequence)
```
    Returns a trimmed sequence (using CharSequence.subsequence()), that omits matching elements at the start and end of the string, using TrimOption.BOTH and SpanCondition.SIMPLE. For example:
```
 

   new UnicodeSet("[ab]").trim("abacatbab")
 
```
    ... returns "cat".
    参数:
    
    sequence - the sequence to trim
    
    返回:
    
    a subsequence
  - trim
```
public CharSequence trim(CharSequence sequence,
                         UnicodeSetSpanner.TrimOption trimOption)
```
    Returns a trimmed sequence (using CharSequence.subsequence()), that omits matching elements at the start or end of the string, using the trimOption and SpanCondition.SIMPLE. For example:
```
 

   new UnicodeSet("[ab]").trim("abacatbab", TrimOption.LEADING)
 
```
    ... returns "catbab".
    参数:
    
    sequence - the sequence to trim
    
    trimOption - LEADING, TRAILING, or BOTH
    
    返回:
    
    a subsequence
  - trim
```
public CharSequence trim(CharSequence sequence,
                         UnicodeSetSpanner.TrimOption trimOption,
                         UnicodeSet.SpanCondition spanCondition)
```
    Returns a trimmed sequence (using CharSequence.subsequence()), that omits matching elements at the start or end of the string, depending on the trimOption and spanCondition. For example:
```
 

   new UnicodeSet("[ab]").trim("abacatbab", TrimOption.LEADING, SpanCondition.SIMPLE)
 
```
    ... returns "catbab".
    参数:
    
    sequence - the sequence to trim
    
    trimOption - LEADING, TRAILING, or BOTH
    
    spanCondition - SIMPLE, CONTAINED or NOT_CONTAINED
    
    返回:
    
    a subsequence

类 UnicodeSetSpanner

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

UnicodeSetSpanner

方法详细资料

getUnicodeSet

equals

hashCode

countIn

countIn

countIn

deleteFrom

deleteFrom

replaceFrom

replaceFrom

replaceFrom

trim

trim

trim