< prev index next >

src/java.base/share/classes/java/text/CollationElementIterator.java

Print this page
rev 57619 : imported patch 8174270
   1 /*
   2  * Copyright (c) 1996, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  24  */
  25 
  26 /*
  27  * (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved
  28  * (C) Copyright IBM Corp. 1996-1998 - All Rights Reserved
  29  *
  30  *   The original version of this source code and documentation is copyrighted
  31  * and owned by Taligent, Inc., a wholly-owned subsidiary of IBM. These
  32  * materials are provided under terms of a License Agreement between Taligent
  33  * and Sun. This technology is protected by multiple US and International
  34  * patents. This notice and attribution to Taligent may not be removed.
  35  *   Taligent is a registered trademark of Taligent, Inc.
  36  *
  37  */
  38 
  39 package java.text;
  40 
  41 import java.lang.Character;
  42 import java.util.Vector;
  43 import sun.text.CollatorUtilities;
  44 import sun.text.normalizer.NormalizerBase;
  45 
  46 /**
  47  * The {@code CollationElementIterator} class is used as an iterator
  48  * to walk through each character of an international string. Use the iterator
  49  * to return the ordering priority of the positioned character. The ordering
  50  * priority of a character, which we refer to as a key, defines how a character
  51  * is collated in the given collation object.
  52  *
  53  * <p>
  54  * For example, consider the following in Spanish:
  55  * <blockquote>
  56  * <pre>
  57  * "ca" &rarr; the first key is key('c') and second key is key('a').
  58  * "cha" &rarr; the first key is key('ch') and second key is key('a').
  59  * </pre>
  60  * </blockquote>
  61  * And in German,
  62  * <blockquote>
  63  * <pre>
  64  * "\u00e4b" &rarr; the first key is key('a'), the second key is key('e'), and


   1 /*
   2  * Copyright (c) 1996, 2020, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  24  */
  25 
  26 /*
  27  * (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved
  28  * (C) Copyright IBM Corp. 1996-1998 - All Rights Reserved
  29  *
  30  *   The original version of this source code and documentation is copyrighted
  31  * and owned by Taligent, Inc., a wholly-owned subsidiary of IBM. These
  32  * materials are provided under terms of a License Agreement between Taligent
  33  * and Sun. This technology is protected by multiple US and International
  34  * patents. This notice and attribution to Taligent may not be removed.
  35  *   Taligent is a registered trademark of Taligent, Inc.
  36  *
  37  */
  38 
  39 package java.text;
  40 
  41 import java.lang.Character;
  42 import java.util.Vector;
  43 import sun.text.CollatorUtilities;
  44 import jdk.internal.icu.text.NormalizerBase;
  45 
  46 /**
  47  * The {@code CollationElementIterator} class is used as an iterator
  48  * to walk through each character of an international string. Use the iterator
  49  * to return the ordering priority of the positioned character. The ordering
  50  * priority of a character, which we refer to as a key, defines how a character
  51  * is collated in the given collation object.
  52  *
  53  * <p>
  54  * For example, consider the following in Spanish:
  55  * <blockquote>
  56  * <pre>
  57  * "ca" &rarr; the first key is key('c') and second key is key('a').
  58  * "cha" &rarr; the first key is key('ch') and second key is key('a').
  59  * </pre>
  60  * </blockquote>
  61  * And in German,
  62  * <blockquote>
  63  * <pre>
  64  * "\u00e4b" &rarr; the first key is key('a'), the second key is key('e'), and


< prev index next >