RuleBasedCollator Class

Definition

The RuleBasedCollator class is a concrete subclass of Collator that provides a simple, data-driven, table collator.

[Android.Runtime.Register("java/text/RuleBasedCollator", DoNotGenerateAcw=true)]
public class RuleBasedCollator : Java.Text.Collator
[<Android.Runtime.Register("java/text/RuleBasedCollator", DoNotGenerateAcw=true)>]
type RuleBasedCollator = class
    inherit Collator
Inheritance
RuleBasedCollator
Attributes

Remarks

The RuleBasedCollator class is a concrete subclass of Collator that provides a simple, data-driven, table collator. With this class you can create a customized table-based Collator. RuleBasedCollator maps characters to sort keys.

RuleBasedCollator has the following restrictions for efficiency (other subclasses may be used for more complex languages) : <ol> <li>If a special collation rule controlled by a &lt;modifier&gt; is specified it applies to the whole collator object. <li>All non-mentioned characters are at the end of the collation order. </ol>

The collation table is composed of a list of collation rules, where each rule is of one of three forms:

&lt;modifier&gt;
               &lt;relation&gt; &lt;text-argument&gt;
               &lt;reset&gt; &lt;text-argument&gt;

The definitions of the rule elements is as follows: <UL> <LI><strong>Text-Argument</strong>: A text-argument is any sequence of characters, excluding special characters (that is, common whitespace characters [0009-000D, 0020] and rule syntax characters [0021-002F, 003A-0040, 005B-0060, 007B-007E]). If those characters are desired, you can put them in single quotes (e.g. ampersand =&gt; '&amp;'). Note that unquoted white space characters are ignored; e.g. b c is treated as bc. <LI><strong>Modifier</strong>: There are currently two modifiers that turn on special collation rules. <UL> <LI>'

Added in 1.1.

Java documentation for java.text.RuleBasedCollator.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

RuleBasedCollator(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

RuleBasedCollator(String)

RuleBasedCollator constructor.

Fields

CanonicalDecomposition

Decomposition mode value.

(Inherited from Collator)
FullDecomposition

Decomposition mode value.

(Inherited from Collator)
Identical

Collator strength value.

(Inherited from Collator)
NoDecomposition

Decomposition mode value.

(Inherited from Collator)
Primary

Collator strength value.

(Inherited from Collator)
Secondary

Collator strength value.

(Inherited from Collator)
Tertiary

Collator strength value.

(Inherited from Collator)

Properties

Class

Returns the runtime class of this Object.

(Inherited from Object)
Decomposition

Get the decomposition mode of this Collator. -or- Set the decomposition mode of this Collator.

(Inherited from Collator)
Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
PeerReference (Inherited from Object)
Rules

Gets the table-based rules for the collation object.

Strength

Returns this Collator's strength property. -or- Sets this Collator's strength property.

(Inherited from Collator)
ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Clone()

Returns a new collator with the same decomposition mode and strength value as this collator.

(Inherited from Collator)
Compare(Object, Object)

Compares its two arguments for order.

(Inherited from Collator)
Compare(String, String)

Compares the character data stored in two different strings based on the collation rules.

Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
Equals(String, String)

Convenience method for comparing the equality of two strings based on this Collator's collation rules.

(Inherited from Collator)
GetCollationElementIterator(ICharacterIterator)

Returns a CollationElementIterator for the given CharacterIterator.

GetCollationElementIterator(String)

Returns a CollationElementIterator for the given String.

GetCollationKey(String)

Transforms the string into a series of characters that can be compared with CollationKey.

GetHashCode()

Generates the hash code for the table-based collation object

JavaFinalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime() (Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

IComparator.Compare(Object, Object) (Inherited from Collator)
IJavaPeerable.Disposed() (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced() (Inherited from Object)
IJavaPeerable.Finalized() (Inherited from Object)
IJavaPeerable.JniManagedPeerState (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to