Skip to content

Consider reporting errors during encoding in ReaderInputStream #6944

Open
@bjmi

Description

@bjmi

API(s)

ReaderInputStream(reader, charset, bufferSize)

How do you want it to be improved?

Use the default error action for malformed input and unmappable characters when creating the encoder by removing following lines:

.onMalformedInput(CodingErrorAction.REPLACE)
.onUnmappableCharacter(CodingErrorAction.REPLACE)

and update the corr. Javadoc.

Why do we need it to be improved?

Data is silently changed and conversion errors are just ignored.
This lead to corrupt data, it is particularly bad if it goes undetected for a long period of time.
Therefore the default behavior should make the user aware of the problem.
Newer introduced API (JDK 11) like java.nio.file.Files.readString(..) and java.nio.file.Files.writeString(..) also use the reporting error approach.

An alternative would be to make ReaderInputStream public and allow to pass a Reader and a CharsetEncoder.
The encoder can be created by the caller via charset.newEncoder() easily and configured according the intended use case.
This was requested in #5376.

Example

No code needs to be changed beforehand. It's just about reporting a problem.

Current Behavior

Encoding errors are silently ignored and lead to corrupt text files.

Desired Behavior

Encoding errors should raise an exception and make errors visible, subsequently the code or data in question gets fixed.

Concrete Use Cases

We process texts from customers that use German and Cyrillic letters and it is crucial that the content remains intact when decoding / encoding is used.

Checklist

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions