Github user aljoscha commented on a diff in the pull request:
https://github.com/apache/flink/pull/5230#discussion_r165377821
--- Diff:
flink-core/src/main/java/org/apache/flink/api/common/state/ReadOnlyBroadcastState.java
---
@@ -0,0 +1,59 @@
+/*
+ * 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.flink.api.common.state;
+
+import org.apache.flink.annotation.PublicEvolving;
+
+import java.util.Map;
+
+/**
+ * A read-only type of state that gives read-only access to the state of a
{@code BroadcastStream}
--- End diff --
I think the `access to the state of a BroadCast` stream bit might be a bit
confusing because it ties it too heavily to broadcast streams.
We should also have a big warning here that you should not modify the
result of `get()` and also that you should not modify the entries in the
immutable iterator because this would lead to problems with the heap state
backend.
---
