dblevins commented on code in PR #84: URL: https://github.com/apache/johnzon/pull/84#discussion_r860563179
########## johnzon-core/src/main/java/org/apache/johnzon/core/Buffered.java: ########## @@ -0,0 +1,36 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.johnzon.core; + +/** + * A <tt>Buffered</tt> is a source or destination of data that is buffered + * before writing or reading. The bufferSize method allows all participants + * in the underlying stream to align on this buffer size for optimization. + * + * This interface is designed in the spirit of {@code java.io.Flushable} and + * {@code java.io.Closeable} + * + * @since 1.2.17 + */ +public interface Buffered { Review Comment: I personally like `Buffered` as it is telling Johnzon a fact, "I am buffered". There is a ByteArrayOutputStream inside the supplied SnippetWriter that Johnzon doesn't control. Johnzon can look at the writers and outputstreams it is given and use the interface to ask, "are you buffered?" and if they are Johnzon can optimize its own buffering to match their buffer size. So to me it makes sense as there's a conversation there: johnzon: are you buffered? writer: yes, I'm buffered. johnzon: Ok, what's your buffer size? writer: It's 50. johnzon: great, I'll write to you 50 bytes at a time That said, if you'd like to rename it after the merge I'm ok with that. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
