dblevins commented on code in PR #84: URL: https://github.com/apache/johnzon/pull/84#discussion_r860535420
########## 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: My first instinct was Bufferable as well. What swayed me away is the "able" interfaces are all describing an action someone can take on the object and if they don't take that action, the thing described is not done. If you don't serialize a `Serializable` it isn't serialized. If you don't close a `Closeable` it isn't closed. `Flushable` objects of course do flush eventually, but the method it has still triggers an action. So calling it `Bufferable` felt a bit off as there's no action for the user to do. It's buffered whether or not the user does anything and calling `bufferSize` does nothing. `Buffered` is a statement of fact and `bufferSize` returns that fact. All that said, I'm not super married to it. That's just the logic that got me there. -- 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]
