[IO-564] The rules of ByteArrayOutputStream.write are not documented.

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.6
• Fix Version/s: 2.12.0
• Component/s: Streams/Writers
• Assignee: Unassigned
• Reporter: Hao Zhong
• Created: 25/Dec/17 02:13
• Updated: 20/Jun/22 18:31
• Resolved: 20/Jun/22 18:31

Description

When I call the ByteArrayOutputStream.write method, it returns exceptions. Its API document is not quite useful, since it does not define any rules. From the thrown exceptions, I cannot get any useful information either. Until I read the code, I understand its usage:

 public void write(final byte[] b, final int off, final int len) {
 if ((off < 0)
                || (off > b.length)
                || (len < 0)
                || ((off + len) > b.length)
                || ((off + len) < 0)) {
            throw new IndexOutOfBoundsException();
        } else if (len == 0) {
            return;
        }
...
}

Would you please explicitly introduce the rules in the doucment? Or, would you please add more messages to the thrown exception? Both ways can make the API easier to understand.