org.codehaus.httpcache4j.payload.InputStreamPayload Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of httpcache4j-api Show documentation
The newest version!
/*
 * Copyright (c) 2008, The Codehaus. All Rights Reserved.
 *
 *   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 org.codehaus.httpcache4j.payload;

import org.codehaus.httpcache4j.MIMEType;

import org.codehaus.httpcache4j.util.AvailableInputStream;

import java.io.InputStream;
import java.util.Objects;

/**
 * Represents a payload that is backed by a one-shot inputstream.
 * The stream may be an arbitrary stream type. If you start
 * reading from the stream, the available flag will be set to false, and the
 * next invocation of  
 */
public final class InputStreamPayload implements Payload {
    private final AvailableInputStream stream;
    private final MIMEType mimeType;
    private final long length;


    public InputStreamPayload(InputStream stream, MIMEType mimeType) {
        this(stream, mimeType, -1);
    }

    /**
     * Constructs an Inputstream payload.
     *
     * @param stream the stream to create the payload from; may not be {@code null}
     * @param mimeType the mime type of the stream. Defaults to
     * application/octet-stream if not set.
     */
    public InputStreamPayload(final InputStream stream, final MIMEType mimeType, long length) {
        if (mimeType != null) {
            this.mimeType = mimeType;
        }
        else {
            this.mimeType = MIMEType.APPLICATION_OCTET_STREAM;
        }
        this.stream = new AvailableInputStream(Objects.requireNonNull(stream, "Inputstream may not be null"));
        this.length = length;
    }

    public MIMEType getMimeType() {
        return mimeType;
    }

    public boolean isAvailable() {
        return stream.isAvailable();
    }

    public InputStream getInputStream() {
        return stream.isAvailable() ? stream : null;
    }

    public long length() {
        return length;
    }
}