com.storedobject.common.BinaryContentGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of so-common Show documentation

SO Common utility classes

There is a newer version: 1.0.9

/*
 * Copyright 2018 Syam Pillai
 *
 * 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 com.storedobject.common;

import java.io.OutputStream;

/**
 * Anything that generates some sort of binary "content".
 *
 * @author Syam
 */
@FunctionalInterface
public interface BinaryContentGenerator extends ContentGenerator {

    /**
     * Generate the content and write to an output stream.
     *
     * @param output Output stream to collect the generated content.
     * @throws Exception if content can not be generated.
     */
    void generateContent(OutputStream output) throws Exception;


    /**
     * Mime type of the content.
     *
     * @return Default implementation returns "application/octet-stream".
     */
    default String getContentType() {
        return "application/octet-stream";
    }

    /**
     * File extension normally used for this type of content.
     *
     * @return Default implementation returns "bin".
     */
    default String getFileExtension() {
        return "bin";
    }
}