Skip to content

Fix FileWriterWithEncoding.Builder ignoring any Charset but the default #877

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.

Sign up for GitHub

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

Open
lenamonj wants to merge 1 commit into
base: master
Choose a base branch
from
+35 −4
Open

Fix FileWriterWithEncoding.Builder ignoring any Charset but the default #877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public class FileWriterWithEncoding extends ProxyWriter {
* FileWriterWithEncoding w = FileWriterWithEncoding.builder()
* .setPath(path)
* .setAppend(false)
* .setCharsetEncoder(StandardCharsets.UTF_8)
* .setCharset(StandardCharsets.UTF_8)
* .get();}
* </pre>
*
Expand Down Expand Up @@ -125,9 +125,6 @@ public FileWriterWithEncoding get() throws IOException {
}

private Object getEncoder() {
if (charsetEncoder != null && getCharset() != null && !charsetEncoder.charset().equals(getCharset())) {
throw new IllegalStateException(String.format("Mismatched Charset(%s) and CharsetEncoder(%s)", getCharset(), charsetEncoder.charset()));
}
return charsetEncoder != null ? charsetEncoder : getCharset();
}

Expand All @@ -142,6 +139,13 @@ public Builder setAppend(final boolean append) {
return this;
}

@Override
public Builder setCharset(final Charset charset) {
super.setCharset(charset);
charsetEncoder = getCharset().newEncoder();
return this;
}

/**
* Sets charsetEncoder to use for encoding.
*
Expand All @@ -150,6 +154,9 @@ public Builder setAppend(final boolean append) {
*/
public Builder setCharsetEncoder(final CharsetEncoder charsetEncoder) {
this.charsetEncoder = charsetEncoder;
if (charsetEncoder != null) {
super.setCharset(charsetEncoder.charset());
}
return this;
}

Expand Down
24 changes: 24 additions & 0 deletions src/test/java/org/apache/commons/io/output/FileWriterWithEncodingTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.apache.commons.io.output;

import static org.apache.commons.io.test.TestUtils.checkFile;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
Expand All @@ -32,6 +33,7 @@
import java.nio.charset.CharsetEncoder;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.Arrays;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
Expand All @@ -42,6 +44,8 @@
*/
class FileWriterWithEncodingTest {

private static final String NON_ASCII = "caf\u00e9";

@TempDir
public File temporaryFolder;

Expand Down Expand Up @@ -204,6 +208,26 @@ void testDifferentEncoding() throws Exception {
}
}

@Test
void testBuilder_nonDefaultCharset() throws Exception {
for (final Charset charset : Arrays.asList(StandardCharsets.UTF_16, StandardCharsets.ISO_8859_1)) {
try (Writer writer = FileWriterWithEncoding.builder().setFile(file2).setCharset(charset).get()) {
writer.write(NON_ASCII);
}
assertArrayEquals(NON_ASCII.getBytes(charset), Files.readAllBytes(file2.toPath()));
}
}

@Test
void testBuilder_nonDefaultCharsetEncoder() throws Exception {
for (final Charset charset : Arrays.asList(StandardCharsets.UTF_16, StandardCharsets.ISO_8859_1)) {
try (Writer writer = FileWriterWithEncoding.builder().setFile(file2).setCharsetEncoder(charset.newEncoder()).get()) {
writer.write(NON_ASCII);
}
assertArrayEquals(NON_ASCII.getBytes(charset), Files.readAllBytes(file2.toPath()));
}
}

@Test
void testSameEncoding_Charset_constructor() throws Exception {
try (FileWriterWithEncoding writer = new FileWriterWithEncoding(file2, Charset.defaultCharset())) {
Expand Down