io.telicent.smart.cache.sources.file.yaml.YamlEventReaderWriter Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) Telicent Ltd
 *
 * Licensed 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 io.telicent.smart.cache.sources.file.yaml;

import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
import io.telicent.smart.cache.sources.file.FileEventAccessMode;
import io.telicent.smart.cache.sources.file.jackson.AbstractJacksonEventReaderWriter;
import org.apache.kafka.common.serialization.Deserializer;
import org.apache.kafka.common.serialization.Serializer;

/**
 * A file event reader that encodes and decodes the events from YAML files
 *
 * @param    Key type
 * @param  Value type
 */
public class YamlEventReaderWriter extends
        AbstractJacksonEventReaderWriter {

    /**
     * Creates a new YAML Event reader writer
     *
     * @param mode              Event access mode
     * @param keyDeserializer   Key deserializer
     * @param valueDeserializer Value deserializer
     * @param keySerializer     Key serializer
     * @param valueSerializer   Value serializer
     */
    YamlEventReaderWriter(FileEventAccessMode mode, Deserializer keyDeserializer,
                          Deserializer valueDeserializer, Serializer keySerializer,
                          Serializer valueSerializer) {
        super(new YAMLMapper(), mode, keySerializer, valueSerializer, keyDeserializer,
              valueDeserializer);
    }

    /**
     * Creates a new YAML Event reader writer
     *
     * @param keyDeserializer   Key deserializer
     * @param valueDeserializer Value deserializer
     * @param keySerializer     Key serializer
     * @param valueSerializer   Value serializer
     */
    YamlEventReaderWriter(Deserializer keyDeserializer, Deserializer valueDeserializer,
                          Serializer keySerializer,
                          Serializer valueSerializer) {
        this(FileEventAccessMode.ReadWrite, keyDeserializer, valueDeserializer, keySerializer, valueSerializer);
    }

    /**
     * Creates a new YAML Event reader
     *
     * @param keyDeserializer   Key deserializer
     * @param valueDeserializer Value deserializer
     */
    public YamlEventReaderWriter(Deserializer keyDeserializer,
                                 Deserializer valueDeserializer) {
        this(FileEventAccessMode.ReadOnly, keyDeserializer, valueDeserializer, null, null);
    }

    /**
     * Creates a new YAML Event writer
     *
     * @param keySerializer   Key serializer
     * @param valueSerializer Value serializer
     */
    public YamlEventReaderWriter(Serializer keySerializer,
                                 Serializer valueSerializer) {
        this(FileEventAccessMode.WriteOnly, null, null, keySerializer, valueSerializer);
    }

    /**
     * Creates a new builder
     *
     * @param    Key type
     * @param  Value type
     * @return Builder
     */
    public static  Builder create() {
        return new Builder<>();
    }

    /**
     * Builder for YAML reader/writers
     *
     * @param    Key type
     * @param  Value type
     */
    public static class Builder {

        private Serializer keySerializer;
        private Serializer valueSerializer;
        private Deserializer keyDeserializer;
        private Deserializer valueDeserializer;

        /**
         * Sets the key serializer
         *
         * @param serializer Serializer
         * @return Builder
         */
        public Builder keySerializer(Serializer serializer) {
            this.keySerializer = serializer;
            return this;
        }

        /**
         * Sets the value serializer
         *
         * @param serializer Serializer
         * @return Builder
         */
        public Builder valueSerializer(Serializer serializer) {
            this.valueSerializer = serializer;
            return this;
        }

        /**
         * Sets the key deserializer
         *
         * @param deserializer Deserializer
         * @return Builder
         */
        public Builder keyDeserializer(Deserializer deserializer) {
            this.keyDeserializer = deserializer;
            return this;
        }

        /**
         * Sets the value deserializer
         *
         * @param deserializer Deserializer
         * @return Builder
         */
        public Builder valueDeserializer(Deserializer deserializer) {
            this.valueDeserializer = deserializer;
            return this;
        }

        /**
         * Builds a new YAML reader/writer
         *
         * @return YAML reader/writer
         */
        public YamlEventReaderWriter build() {
            FileEventAccessMode mode = FileEventAccessMode.ReadWrite;
            if (this.keySerializer == null && this.valueSerializer == null) {
                mode = FileEventAccessMode.ReadOnly;
            } else if (this.keyDeserializer == null && this.valueDeserializer == null) {
                mode = FileEventAccessMode.WriteOnly;
            }
            return new YamlEventReaderWriter<>(mode, this.keyDeserializer, this.valueDeserializer, this.keySerializer,
                                               this.valueSerializer
            );
        }
    }
}