nstream.persist.store.snapshot.FileSupplier Maven / Gradle / Ivy
// Copyright 2015-2024 Nstream, inc.
//
// 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 nstream.persist.store.snapshot;
import java.io.IOException;
import java.io.InputStream;
/**
* A single file to be included in a snapshot.
*/
public interface FileSupplier {
/**
* @return A stream that will provide the contents of the file.
* @throws IOException The file data could not be read.
*/
InputStream provide() throws IOException;
/**
* @return The number of bytes that the stream created by {@link FileSupplier#provide()} will produce.
*/
long size();
}