From 3458c499c96add928ab54085d76053058d5569bb Mon Sep 17 00:00:00 2001
From: Naoto Sato <naoto@openjdk.org>
Date: Thu, 9 Dec 2010 11:56:38 -0800
Subject: [PATCH] 6486695: [Col] Doc: CollationElementIterator example assumes
 Collator.getInstance return type

Reviewed-by: okutsu
---
 .../java/text/CollationElementIterator.java        | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/jdk/src/share/classes/java/text/CollationElementIterator.java b/jdk/src/share/classes/java/text/CollationElementIterator.java
index 4fb294d423a..6bdd0d04a7e 100644
--- a/jdk/src/share/classes/java/text/CollationElementIterator.java
+++ b/jdk/src/share/classes/java/text/CollationElementIterator.java
@@ -79,9 +79,13 @@ import sun.text.normalizer.NormalizerBase;
  * <pre>
  *
  *  String testString = "This is a test";
- *  RuleBasedCollator ruleBasedCollator = (RuleBasedCollator)Collator.getInstance();
- *  CollationElementIterator collationElementIterator = ruleBasedCollator.getCollationElementIterator(testString);
- *  int primaryOrder = CollationElementIterator.primaryOrder(collationElementIterator.next());
+ *  Collator col = Collator.getInstance();
+ *  if (col instanceof RuleBasedCollator) {
+ *      RuleBasedCollator ruleBasedCollator = (RuleBasedCollator)col;
+ *      CollationElementIterator collationElementIterator = ruleBasedCollator.getCollationElementIterator(testString);
+ *      int primaryOrder = CollationElementIterator.primaryOrder(collationElementIterator.next());
+ *          :
+ *  }
  * </pre>
  * </blockquote>
  *
@@ -93,6 +97,10 @@ import sun.text.normalizer.NormalizerBase;
  * is its primary order; the next 8 bits is the secondary order and the
  * last 8 bits is the tertiary order.
  *
+ * <p><b>Note:</b> <code>CollationElementIterator</code> is a part of
+ * <code>RuleBasedCollator</code> implementation. It is only usable
+ * with <code>RuleBasedCollator</code> instances.
+ *
  * @see                Collator
  * @see                RuleBasedCollator
  * @author             Helena Shih, Laura Werner, Richard Gillam