cmccabe commented on code in PR #13280: URL: https://github.com/apache/kafka/pull/13280#discussion_r1167076930
########## server-common/src/main/java/org/apache/kafka/server/immutable/ImmutableMap.java: ########## @@ -0,0 +1,47 @@ +/* + * 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.kafka.server.immutable; + +import java.util.Map; + +/** + * A persistent Hash-based Map wrapper. + * java.util.Map methods that mutate in-place will throw UnsupportedOperationException + * + * @param <K> the key type + * @param <V> the value type + */ +public interface ImmutableMap<K, V> extends Map<K, V> { + /** + * @return the underlying persistent map + */ + Object underlying(); + + /** + * @param key the key + * @param value the value + * @return a wrapped persistent map that differs from this one in that the given mapping is added (if necessary) + */ + ImmutableMap<K, V> updated(K key, V value); Review Comment: Oh, I didn't realize this was an existing convention. Let's go with that then. ########## server-common/src/main/java/org/apache/kafka/server/immutable/ImmutableMap.java: ########## @@ -0,0 +1,47 @@ +/* + * 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.kafka.server.immutable; + +import java.util.Map; + +/** + * A persistent Hash-based Map wrapper. + * java.util.Map methods that mutate in-place will throw UnsupportedOperationException + * + * @param <K> the key type + * @param <V> the value type + */ +public interface ImmutableMap<K, V> extends Map<K, V> { + /** + * @return the underlying persistent map + */ + Object underlying(); + + /** + * @param key the key + * @param value the value + * @return a wrapped persistent map that differs from this one in that the given mapping is added (if necessary) + */ + ImmutableMap<K, V> updated(K key, V value); + + /** + * @param key the key + * @return a wrapped persistent map that differs from this one in that the given mapping is removed (if necessary) + */ + ImmutableMap<K, V> removed(K key); Review Comment: Oh, I didn't realize this was an existing convention. Let's go with that then. -- 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: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
