# CP1252Collator.java

    /*
    ** Module   : CP1252Collator.java
    ** Abstract : A collator using Progress-like rules for CP1252
    **
    ** Copyright (c) 2021-2022, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
    ** 001 OM  20210624 First revision using extracted data from locale/en_US@cp1252_fwd_basic.
    **     OM  20210728 Renamed FwdCollatorProvider class and fwdspi.jar library.
    **     OM  20220311 Refactoring: extracted BaseFwdCollator base class for all 8-bit collators.
    */

    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program is distributed in the hope that it will be useful,
    ** but WITHOUT ANY WARRANTY; without even the implied warranty of
    ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.spi;

    import java.io.*;
    import java.text.*;

    /**
     * A collator using Progress-like rules for the CP1252 character set.
     * <p>
     * Each code point in the character set is sorted uniquely and no allowances are made for varying collation
     * strength. There are no ignorable characters.
     */
    public final class CP1252Collator
    extends BaseFwdCollator
    {
       /**
        * CP1252 code points, in ascending collation order.
        * <p>
        * NOTE: codepoints {@code 0x81}, {@code 0x8D}, {@code 0x8F}, {@code 0x90} and {@code 0x9D} are not defined
        *       for this CP and all of them will be converted to {@code \uFFFD} ({@code REPLACEMENT-CHARACTER})
        *       causing the {@link RuleBasedCollator} c'tor to fail with {@link java.text.ParseException}.
        */
       private static final int[] CP1252_POINTS =
       {
          0x00, 0x01, 0x02,   0x03,   0x04, 0x05, 0x06,   0x07,     0x08,   0x09,   0x0A,   0x0B,   0x0C, 0x0D, 0x0E, 0x0F,
          0x10, 0x11, 0x12,   0x13,   0x14, 0x15, 0x16,   0x17,     0x18,   0x19,   0x1A,   0x1B,   0x1C, 0x1D, 0x1E, 0x1F,
          0x20, 0x21, 0x22,   0x23,   0x24, 0x25, 0x26,   0x27,     0x28,   0x29,   0x2A,   0x2B,   0x2C, 0x2D, 0x2E, 0x2F,
          0x30, 0x31, 0x32,   0x33,   0x34, 0x35, 0x36,   0x37,     0x38,   0x39,   0x3A,   0x3B,   0x3C, 0x3D, 0x3E, 0x3F,
          0x40, 0x41, 0xC0,   0xC1,   0xC2, 0xC3, 0xC4,   0x42,     0x43,   0xC7,   0x44,   0x45,   0xC8, 0xC9, 0xCA, 0xCB,
          0x46, 0x47, 0x48,   0x49,   0xCC, 0xCD, 0xCE,   0xCF,     0x4A,   0x4B,   0x4C,   0x4D,   0x4E, 0xD1, 0x4F, 0x8C,
          0xD2, 0xD3, 0xD4,   0xD5,   0xD6, 0x50, 0x51,   0x52,     0xDF,   0x53,   0x8A,   0x54,   0x55, 0xD9, 0xDA, 0xDB,
          0xDC, 0x56, 0x57,   0x58,   0x59, 0x9F, 0xDD,   0x5A,     0x8E,   0x5B,   0x5C,   0x5D,   0x5E, 0x5F, 0x60, 0x61,
          0xE0, 0xE1, 0xE2,   0xE3,   0xE4, 0x62, 0x63,   0xE7,     0x64,   0x65,   0xE8,   0xE9,   0xEA, 0xEB, 0x66, 0x67,
          0x68, 0x69, 0xEC,   0xED,   0xEE, 0xEF, 0x6A,   0x6B,     0x6C,   0x6D,   0x6E,   0xF1,   0x6F, 0x9C, 0xF2, 0xF3,
          0xF4, 0xF5, 0xF6,   0x70,   0x71, 0x72, 0x73,   0x9A,     0x9E,   0x74,   0x75,   0xF9,   0xFA, 0xFB, 0xFC, 0x76,
          0x77, 0x78, 0x79,   0xFD,   0xFF, 0x7A, 0x7B,   0x7C,     0x7D,   0x7E,   0x7F,   0xE5,   0xC5, 0xE6, 0xC6, 0xF8,
          0xA3, 0xD8, 0xD7,   0xBF,   0xBD, 0xBC, 0xA1,   0xAB,     0xBB,   0x80, /*0x81,*/ 0x82,   0x83, 0x84, 0xA9, 0x85,
          0x86, 0x87, 0x88,   0xA2,   0xA5, 0x89, 0x8B, /*0x8D,*/ /*0x8F,*/ 0xAE,   0xAC, /*0x90,*/ 0x91, 0x92, 0x93, 0x94,
          0x95, 0x96, 0xA4,   0xF0,   0xD0, 0x97, 0x98,   0x99,     0x9B,   0xA6,   0xAA,   0xBA,   0xB5, 0xFE, 0xDE, 0xAF,
          0xB4, 0xAD, 0xB1, /*0x9D,*/ 0xBE, 0xB6, 0xA7,   0xF7,     0xB8,   0xB0,   0xA8,   0xB7,   0xB9, 0xB3, 0xB2, 0xA0,
       };

       /**
        * Default constructor. This class is constructed from within this package by the
        * {@link FwdCollatorProvider}.
        *
        * @throws  UnsupportedEncodingException
        *          if there is an error generating the rules.
        * @throws  ParseException
        *          if there is an error parsing the rules.
        */
       CP1252Collator()
       throws UnsupportedEncodingException,
              ParseException
       {
          super("CP1252", CP1252_POINTS);
       }
    }