# HG changeset patch # User jlaskey # Date 1545248674 14400 # Wed Dec 19 15:44:34 2018 -0400 # Node ID aecf4daa1ebf7dbc26540e03fc9d4b1e63991f76 # Parent 4c539cb116336809b0b31801e17f4e5ba1344839 8215489: Remove String::align Reviewed-by: briangoetz diff --git a/src/java.base/share/classes/java/lang/String.java b/src/java.base/share/classes/java/lang/String.java --- a/src/java.base/share/classes/java/lang/String.java +++ b/src/java.base/share/classes/java/lang/String.java @@ -2869,116 +2869,6 @@ } /** - * Removes vertical and horizontal white space margins from around the - * essential body of a multi-line string, while preserving relative - * indentation. - *

- * This string is first conceptually separated into lines as if by - * {@link String#lines()}. - *

- * Then, the minimum indentation (min) is determined as follows. For - * each non-blank line (as defined by {@link String#isBlank()}), the - * leading {@link Character#isWhitespace(int) white space} characters are - * counted. The min value is the smallest of these counts. - *

- * For each non-blank line, min leading white space characters are - * removed. Each white space character is treated as a single character. In - * particular, the tab character {@code "\t"} (U+0009) is considered a - * single character; it is not expanded. - *

- * Leading and trailing blank lines, if any, are removed. Trailing spaces are - * preserved. - *

- * Each line is suffixed with a line feed character {@code "\n"} (U+000A). - *

- * Finally, the lines are concatenated into a single string and returned. - * - * @apiNote - * This method's primary purpose is to shift a block of lines as far as - * possible to the left, while preserving relative indentation. Lines - * that were indented the least will thus have no leading white space. - * - * Example: - *

-     * `
-     *      This is the first line
-     *          This is the second line
-     * `.align();
-     *
-     * returns
-     * This is the first line
-     *     This is the second line
-     * 
- * - * @return string with margins removed and line terminators normalized - * - * @see String#lines() - * @see String#isBlank() - * @see String#indent(int) - * @see Character#isWhitespace(int) - * - * @since 12 - */ - public String align() { - return align(0); - } - - /** - * Removes vertical and horizontal white space margins from around the - * essential body of a multi-line string, while preserving relative - * indentation and with optional indentation adjustment. - *

- * Invoking this method is equivalent to: - *

- * {@code this.align().indent(n)} - *
- * - * @apiNote - * Examples: - *
-     * `
-     *      This is the first line
-     *          This is the second line
-     * `.align(0);
-     *
-     * returns
-     * This is the first line
-     *     This is the second line
-     *
-     *
-     * `
-     *    This is the first line
-     *       This is the second line
-     * `.align(4);
-     * returns
-     *     This is the first line
-     *         This is the second line
-     * 
- * - * @param n number of leading white space characters - * to add or remove - * - * @return string with margins removed, indentation adjusted and - * line terminators normalized - * - * @see String#align() - * - * @since 12 - */ - public String align(int n) { - if (isEmpty()) { - return ""; - } - int outdent = lines().filter(not(String::isBlank)) - .mapToInt(String::indexOfNonWhitespace) - .min() - .orElse(0); - // overflow-conscious code - int indent = n - outdent; - return indent(indent > n ? Integer.MIN_VALUE : indent, true); - } - - /** * This method allows the application of a function to {@code this} * string. The function should expect a single String argument * and produce an {@code R} result. diff --git a/test/jdk/java/lang/String/AlignIndent.java b/test/jdk/java/lang/String/Indent.java rename from test/jdk/java/lang/String/AlignIndent.java rename to test/jdk/java/lang/String/Indent.java --- a/test/jdk/java/lang/String/AlignIndent.java +++ b/test/jdk/java/lang/String/Indent.java @@ -23,8 +23,8 @@ /* * @test - * @summary Unit tests for String#align and String#indent - * @run main AlignIndent + * @summary Unit tests for String#indent + * @run main Indent */ import java.util.Arrays; @@ -32,7 +32,7 @@ import java.util.stream.Collectors; import java.util.stream.Stream; -public class AlignIndent { +public class Indent { static final List ENDS = List.of("", "\n", " \n", "\n\n", "\n\n\n"); static final List MIDDLES = List.of( "", @@ -51,84 +51,12 @@ public static void main(String[] args) { test1(); - test2(); - test3(); - test4(); - } - - /* - * Test String#align() functionality. - */ - static void test1() { - for (String prefix : ENDS) { - for (String suffix : ENDS) { - for (String middle : MIDDLES) { - { - String input = prefix + " abc \n" + middle + "\n def \n" + suffix; - String output = input.align(); - - String[] inLines = input.split("\\R"); - String[] outLines = output.split("\\R"); - - String[] inLinesBody = getBody(inLines); - - if (inLinesBody.length < outLines.length) { - report("String::align()", "Result has more lines than expected", input, output); - } else if (inLinesBody.length > outLines.length) { - report("String::align()", "Result has fewer lines than expected", input, output); - } - - int indent = -1; - for (int i = 0; i < inLinesBody.length; i++) { - String in = inLinesBody[i]; - String out = outLines[i]; - if (!out.isBlank()) { - int offset = in.indexOf(out); - if (offset == -1) { - report("String::align()", "Portions of line are missing", input, output); - } - if (indent == -1) { - indent = offset; - } else if (offset != indent) { - report("String::align()", - "Inconsistent indentation in result", input, output); - } - } - } - } - } - } - } - } - - /* - * Test String#align(int n) functionality. - */ - static void test2() { - for (int adjust : new int[] {-8, -7, -4, -3, -2, -1, 0, 1, 2, 3, 4, 7, 8}) { - for (String prefix : ENDS) { - for (String suffix : ENDS) { - for (String middle : MIDDLES) { - { - String input = prefix + " abc \n" + middle + "\n def \n" + suffix; - String output = input.align(adjust); - String expected = input.align().indent(adjust); - - if (!output.equals(expected)) { - report("String::align(int n)", - "Result inconsistent with align().indent(n)", expected, output); - } - } - } - } - } - } } /* * Test String#indent(int n) functionality. */ - static void test3() { + static void test1() { for (int adjust : new int[] {-8, -7, -4, -3, -2, -1, 0, 1, 2, 3, 4, 7, 8}) { for (String prefix : ENDS) { for (String suffix : ENDS) { @@ -155,18 +83,6 @@ } } - /* - * JDK-8212694: Using Raw String Literals with align() and Integer.MIN_VALUE causes out of memory error - */ - static void test4() { - try { - String str = "\n A\n".align(Integer.MIN_VALUE); - } catch (OutOfMemoryError ex) { - System.err.println("align(Integer.MIN_VALUE) not clipping indentation"); - throw new RuntimeException(); - } - } - public static int indexOfNonWhitespace(String s) { int left = 0; while (left < s.length()) {