Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

4926314: Optimize Reader.read(CharBuffer) #1915

Open
wants to merge 15 commits into
base: master
from
@@ -0,0 +1,84 @@
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code 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 General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

/*
* @test
* @bug 4926314
* @summary Test for InputStreamReader#read(CharBuffer).
* @run testng ReadCharBuffer
*/

import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;

import java.io.*;

This comment has been minimized.

@bplb

bplb Feb 16, 2021
Member

It's generally better not to use a wild card.

This comment has been minimized.

@marschall

marschall Mar 13, 2021
Author Contributor

Done

import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.util.Arrays;

import static java.nio.charset.StandardCharsets.US_ASCII;
import static org.testng.Assert.assertEquals;

public class ReadCharBuffer {

private static final int BUFFER_SIZE = 24;

@DataProvider(name = "buffers")
public Object[][] createBuffers() {
// test both on-heap and off-heap buffers has they make use different code paths

This comment has been minimized.

@bplb

bplb Apr 16, 2021
Member

"as they may"

return new Object[][]{
new Object[]{CharBuffer.allocate(BUFFER_SIZE)},
new Object[]{ByteBuffer.allocateDirect(BUFFER_SIZE * 2).asCharBuffer()}
};
}

@Test(dataProvider = "buffers")
public void read(CharBuffer buffer) throws IOException {
fillBuffer(buffer);

try (Reader reader = new InputStreamReader(new ByteArrayInputStream("ABCDEFGHIJKLMNOPQRTUVWXYZ".getBytes(US_ASCII)), US_ASCII)) {
buffer.limit(7);
buffer.position(1);
assertEquals(reader.read(buffer), 6);
assertEquals(buffer.position(), 7);
assertEquals(buffer.limit(), 7);

buffer.limit(16);
buffer.position(8);
assertEquals(reader.read(buffer), 8);
assertEquals(buffer.position(), 16);
assertEquals(buffer.limit(), 16);
}

buffer.clear();

This comment has been minimized.

@bplb

bplb Feb 16, 2021
Member

I think buffer.rewind() would be more in keeping with the specification verbiage although there will be no practical effect here. Same comment applies below and in the other test ReadCharBuffer.

This comment has been minimized.

@marschall

marschall Mar 13, 2021
Author Contributor

buffer.rewind() would not work in this specific case as it does not reset the limit. I want to assert the entire buffers content to make sure the method didn't accidentally write where it shouldn't have. Therefore limit needs to be set to capacity.

assertEquals(buffer.toString(), "xABCDEFxGHIJKLMNxxxxxxxx");
}

private void fillBuffer(CharBuffer buffer) {
char[] filler = new char[BUFFER_SIZE];
Arrays.fill(filler, 'x');
buffer.put(filler);
buffer.clear();
}

}
@@ -0,0 +1,86 @@
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code 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 General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

/*
* @test
* @bug 4926314
* @summary Test for Reader#read(CharBuffer).
* @run testng ReadCharBuffer
*/

import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;

import java.io.*;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.util.Arrays;

import static java.nio.charset.StandardCharsets.US_ASCII;

import static org.testng.Assert.assertEquals;

@Test(groups = "unit")
public class ReadCharBuffer {

private static final int BUFFER_SIZE = 24;

@DataProvider(name = "buffers")
public Object[][] createBuffers() {
// test both on-heap and off-heap buffers has they make use different code paths

This comment has been minimized.

@bplb

bplb Apr 16, 2021
Member

"as they may"

return new Object[][]{
new Object[]{CharBuffer.allocate(BUFFER_SIZE)},
new Object[]{ByteBuffer.allocateDirect(BUFFER_SIZE * 2).asCharBuffer()}
};
}

@Test(dataProvider = "buffers")
public void read(CharBuffer buffer) throws IOException {
fillBuffer(buffer);

try (Reader reader = new StringReader("ABCDEFGHIJKLMNOPQRTUVWXYZ")) {
buffer.limit(7);
buffer.position(1);
assertEquals(reader.read(buffer), 6);
assertEquals(buffer.position(), 7);
assertEquals(buffer.limit(), 7);

buffer.limit(16);
buffer.position(8);
assertEquals(reader.read(buffer), 8);
assertEquals(buffer.position(), 16);
assertEquals(buffer.limit(), 16);
}

buffer.clear();
assertEquals(buffer.toString(), "xABCDEFxGHIJKLMNxxxxxxxx");
}

private void fillBuffer(CharBuffer buffer) {
char[] filler = new char[BUFFER_SIZE];
Arrays.fill(filler, 'x');
buffer.put(filler);
buffer.clear();
}

}
ProTip! Use n and p to navigate between commits in a pull request.