nifi-commons/nifi-record/src/main/java/org/apache/nifi/serialization/RecordSetWriter.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.nifi.serialization;

import java.io.IOException;
import java.io.OutputStream;

import org.apache.nifi.serialization.record.RecordSet;

/**
 * <p>
 * A ResultSetWriter is responsible for writing a ResultSet to a given {@link OutputStream}.
 * </p>
 *
 * <p>
 * PLEASE NOTE: This interface is still considered 'unstable' and may change in a non-backward-compatible
 * manner between minor or incremental releases of NiFi.
 * </p>
 */
public interface RecordSetWriter extends RecordWriter {
    /**
     * Writes the given result set to the given output stream
     *
     * @param recordSet the record set to serialize
     *
     * @return the results of writing the data
     * @throws IOException if unable to write to the given OutputStream
     */
    WriteResult write(RecordSet recordSet) throws IOException;

    /**
     * Begins a new RecordSet
     *
     * @throws IOException if unable to write to the underlying OutputStream
     * @throws IllegalStateException if a RecordSet has already been started
     */
    void beginRecordSet() throws IOException;

    /**
     * Finishes the currently active RecordSet and returns a WriteResult that includes information about what was written
     *
     * @return the results of writing the data
     * @throws IOException if unable to write to the given OutputStream
     * @throws IllegalStateException if a RecordSet has not been started via {@link #beginRecordSet()}
     */
    WriteResult finishRecordSet() throws IOException;
}