org.instancio.feed.DataSource Maven / Gradle / Ivy

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

The standalone module of Instancio

There is a newer version: 5.0.2

/*
 * Copyright 2022-2024 the original author or authors.
 *
 * 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
 *
 *      https://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.instancio.feed;

import org.instancio.documentation.ExperimentalApi;

import java.io.IOException;
import java.io.InputStream;

/**
 * A data source for specs defined by a {@link Feed}.
 *
 * @see Feed
 * @see Feed.Source
 * @since 5.0.0
 */
@ExperimentalApi
@FunctionalInterface
public interface DataSource {

    /**
     * Returns an input stream containing the data for a {@link Feed}.
     *
     * @return data input steam
     * @throws IOException if an IO error occurs
     * @since 5.0.0
     */
    @ExperimentalApi
    InputStream getInputStream() throws IOException;

    /**
     * Returns the name of this data source, if applicable
     * (for example, file name).
     *
     * @return resource name, or {@code null} if not applicable
     * @since 5.0.0
     */
    @ExperimentalApi
    default String getName() {
        return null;
    }
}