spark.serialization.Serializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spark-core Show documentation

A micro framework for creating web applications in Kotlin and Java 8 with minimal effort

The newest version!

/*
 * Copyright 2015 - Per Wendel
 *
 *  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 spark.serialization;

import java.io.IOException;
import java.io.OutputStream;

import spark.Request;
import spark.Response;

/**
 * Class that serializers and writes the result to given output stream.
 *
 * @author alex
 */
public abstract class Serializer {

    private Serializer next;

    /**
     * Sets the next serializer in the chain.
     *
     * @param serializer the next serializer.
     */
    public void setNext(Serializer serializer) {
        this.next = serializer;
    }

    /**
     * Wraps {@link Serializer#process(OutputStream, Object, Request, Response)} and calls next serializer in chain.
     *
     * @param outputStream the output stream.
     * @param element      the element to process.
     * @param request
     * @param response
     * @throws IOException IOException in case of IO error.
     */
    public void processElement(OutputStream outputStream, Object element, Request request, Response response) throws IOException {
        if (canProcess(element)) {
            process(outputStream, element, request, response);
        } else {
            if (next != null) {
                this.next.processElement(outputStream, element, request, response);
            }
        }
    }

    /**
     * Checks if the serializer implementation can process the element type.
     *
     * @param element the element to process.
     * @return true if the serializer can process the provided element.
     */
    public abstract boolean canProcess(Object element);

    /**
     * Processes the provided element and serializes to output stream.
     *
     * @param outputStream the output stream.
     * @param element      the element.
     * @param request
     * @param response
     * @throws IOException In the case of IO error.
     */
    public abstract void process(OutputStream outputStream, Object element, Request request, Response response) throws IOException;
}