org.apache.flink.formats.protobuf.deserialize.PbCodegenDeserializer Maven / Gradle / Ivy
/*
* 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.formats.protobuf.deserialize;
import org.apache.flink.formats.protobuf.PbCodegenException;
/**
* PbCodegenDes is responsible for converting `messageGetStr` to flink internal row compatible
* structure by codegen process. The codegen procedure could be considered as `returnVarName` =
* codegen(`messageGetStr`)
*/
public interface PbCodegenDeserializer {
/**
* @param returnVarName the final var name that is calculated by codegen. This var name will be
* used by outsider codegen environment.
* @param messageGetStr may be a variable or expression. Current codegen environment can use
* this literal name directly to access the input.
* @return
*/
String codegen(String returnVarName, String messageGetStr) throws PbCodegenException;
}