View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      https://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.lang3.text.translate;
19  
20  import static org.junit.jupiter.api.Assertions.assertEquals;
21  
22  import org.apache.commons.lang3.AbstractLangTest;
23  import org.junit.jupiter.api.Test;
24  
25  /**
26   * Tests for {@link org.apache.commons.lang3.text.translate.UnicodeEscaper}.
27   */
28  @Deprecated
29  class UnicodeEscaperTest extends AbstractLangTest {
30  
31      @Test
32      void testAbove() {
33          final UnicodeEscaper ue = UnicodeEscaper.above('F');
34          final String input = "ADFGZ";
35          final String result = ue.translate(input);
36          assertEquals("ADF\\u0047\\u005A", result, "Failed to escape Unicode characters via the above method");
37      }
38  
39      @Test
40      void testBelow() {
41          final UnicodeEscaper ue = UnicodeEscaper.below('F');
42          final String input = "ADFGZ";
43          final String result = ue.translate(input);
44          assertEquals("\\u0041\\u0044FGZ", result, "Failed to escape Unicode characters via the below method");
45      }
46  
47      @Test
48      void testBetween() {
49          final UnicodeEscaper ue = UnicodeEscaper.between('F', 'L');
50          final String input = "ADFGZ";
51          final String result = ue.translate(input);
52          assertEquals("AD\\u0046\\u0047Z", result, "Failed to escape Unicode characters via the between method");
53      }
54  
55      @Test
56      void testSupplementary() {
57          final UnicodeEscaper ue = UnicodeEscaper.above(0x7f);
58          // U+10437 (DESERET SMALL LETTER YEE) encodes to surrogate pair U+D801 U+DC37.
59          final String input = new String(Character.toChars(0x10437));
60          final String result = ue.translate(input);
61          assertEquals("\\uD801\\uDC37", result, "Supplementary code point must escape to a surrogate pair");
62          assertEquals(input, new UnicodeUnescaper().translate(result), "Escaped supplementary code point must round-trip");
63      }
64  
65      @Test
66      void testToUtf16EscapeBmp() {
67          final UnicodeEscaper ue = new UnicodeEscaper();
68          // A BMP code point below U+1000 needs zero padding to keep the four digit \\uXXXX form.
69          assertEquals("\\u0000", ue.toUtf16Escape(0), "Code point 0 must escape to four hex digits");
70          assertEquals("\\u000A", ue.toUtf16Escape('\n'), "Code point 0xA must escape to four hex digits");
71          assertEquals("\\u0041", ue.toUtf16Escape('A'), "Code point 0x41 must escape to four hex digits");
72          assertEquals("\\u0FFF", ue.toUtf16Escape(0xFFF), "Code point 0xFFF must escape to four hex digits");
73          assertEquals("\\uFFFF", ue.toUtf16Escape(0xFFFF), "Code point 0xFFFF must escape to four hex digits");
74          assertEquals(ue.translate("A"), ue.toUtf16Escape('A'), "toUtf16Escape must match the translate output");
75          assertEquals("A", new UnicodeUnescaper().translate(ue.toUtf16Escape('A')), "Escaped BMP code point must round-trip");
76      }
77  }