org.seedstack.business.data.DataExporter Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2013-2024, The SeedStack authors 
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.seedstack.business.data;

import java.util.stream.Stream;

/**
 * Implement this interface to create a data set exporter that will handle objects of a specific
 * type. A data exporter must be marked with a {@link DataSet} annotation to be recognized.
 *
 * @param  the type this data exporter handles.
 */
public interface DataExporter {

    /**
     * This method is called by SEED to export data handled by this exporter. A lazy iterator of all
     * data to export should be returned.
     *
     * @return the stream of all data to export.
     */
    Stream exportData();

    /**
     * Returns the data class managed by the exporter.
     *
     * @return the data class.
     */
    Class getExportedClass();
}