UnicodeSetSpanner

UnicodeSetSpanner

UnicodeSetSpanner(source: UnicodeSet!)

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.

countIn

open fun countIn(sequence: CharSequence!): Int

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.

countIn

open fun countIn(
    sequence: CharSequence!, 
    countMethod: UnicodeSetSpanner.CountMethod!
): Int

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.

countIn

open fun countIn(
    sequence: CharSequence!, 
    countMethod: UnicodeSetSpanner.CountMethod!, 
    spanCondition: UnicodeSet.SpanCondition!
): Int

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.

deleteFrom

open fun deleteFrom(sequence: CharSequence!): String!

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.

deleteFrom

open fun deleteFrom(
    sequence: CharSequence!, 
    spanCondition: UnicodeSet.SpanCondition!
): String!

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.

equals

open fun equals(other: Any?): Boolean

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getUnicodeSet

open fun getUnicodeSet(): UnicodeSet!

Returns the UnicodeSet used for processing. It is frozen iff the original was.

hashCode

open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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 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 equals 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.

replaceFrom

open fun replaceFrom(
    sequence: CharSequence!, 
    replacement: CharSequence!
): String!

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.

replaceFrom

open fun replaceFrom(
    sequence: CharSequence!, 
    replacement: CharSequence!, 
    countMethod: UnicodeSetSpanner.CountMethod!
): String!

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.

replaceFrom

open fun replaceFrom(
    sequence: CharSequence!, 
    replacement: CharSequence!, 
    countMethod: UnicodeSetSpanner.CountMethod!, 
    spanCondition: UnicodeSet.SpanCondition!
): String!

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.

trim

open fun trim(sequence: CharSequence!): CharSequence!

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:

<code>new UnicodeSet("[ab]").trim("abacatbab")</code>

trim

open fun trim(
    sequence: CharSequence!, 
    trimOption: UnicodeSetSpanner.TrimOption!
): CharSequence!

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:

<code>new UnicodeSet("[ab]").trim("abacatbab", TrimOption.LEADING)</code>

trim

open fun trim(
    sequence: CharSequence!, 
    trimOption: UnicodeSetSpanner.TrimOption!, 
    spanCondition: UnicodeSet.SpanCondition!
): CharSequence!

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:

<code>new UnicodeSet("[ab]").trim("abacatbab", TrimOption.LEADING, SpanCondition.SIMPLE)</code>