View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shardingsphere.db.protocol.mysql.packet.binlog.row.column.value;
19  
20  import org.apache.shardingsphere.db.protocol.mysql.packet.binlog.row.column.MySQLBinlogColumnDef;
21  import org.apache.shardingsphere.db.protocol.mysql.packet.command.query.binary.execute.protocol.MySQLBinaryProtocolValue;
22  import org.apache.shardingsphere.db.protocol.mysql.payload.MySQLPacketPayload;
23  
24  import java.io.Serializable;
25  
26  /**
27   * MySQL binlog protocol column value.
28   *
29   * <p>
30   *     There are no detail documents about the value in row-based replication protocol.
31   *     And many types of value protocol are different with {@link MySQLBinaryProtocolValue}
32   * </p>
33   */
34  public interface MySQLBinlogProtocolValue {
35      
36      /**
37       * Read column value from binlog protocol.
38       *
39       * @param columnDef column definition from TABLE_MAP_EVENT
40       * @param payload payload operation for MySQL binlog packet
41       * @return column value
42       */
43      Serializable read(MySQLBinlogColumnDef columnDef, MySQLPacketPayload payload);
44  }