Github user pnowojski commented on a diff in the pull request:
https://github.com/apache/flink/pull/6323#discussion_r202521065
--- Diff: flink-libraries/flink-table/src/main/scala/org/apache/flink/table/factories/TableFormatFactory.scala
---
@@ -16,42 +16,17 @@
* limitations under the License.
*/
-package org.apache.flink.table.formats
+package org.apache.flink.table.factories
import java.util
-import org.apache.flink.api.common.serialization.{DeserializationSchema, SerializationSchema}
-
/**
- * A factory to create different table format instances. This factory is used with Java's
Service
- * Provider Interfaces (SPI) for discovering. A factory is called with a set of normalized
- * properties that describe the desired format. The factory allows for matching to the
given set of
- * properties. See also [[SerializationSchemaFactory]] and [[DeserializationSchemaFactory]]
for
- * creating configured instances of format classes accordingly.
- *
- * Classes that implement this interface need to be added to the
- * "META_INF/services/org.apache.flink.table.formats.TableFormatFactory' file of a JAR
file in
- * the current classpath to be found.
+ * A factory to create configured table format instances based on string-based properties.
See
+ * also [[TableFactory]] for more information.
*
* @tparam T record type that the format produces or consumes
*/
-trait TableFormatFactory[T] {
-
- /**
- * Specifies the context that this factory has been implemented for. The framework
guarantees
- * to only use the factory if the specified set of properties and values are met.
- *
- * Typical properties might be:
- * - format.type
- * - format.version
- *
- * Specified property versions allow the framework to provide backwards compatible
properties
- * in case of string format changes:
- * - format.property-version
- *
- * An empty context means that the factory matches for all requests.
- */
- def requiredContext(): util.Map[String, String]
+trait TableFormatFactory[T] extends TableFactory {
--- End diff --
Maybe in that case deduplicate comment with `@See` java doc pointer? Otherwise there is
huge risk of comments drifting out of sink.
---
|