nifi-commons/nifi-record/src/main/java/org/apache/nifi/serialization/RecordWriter.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.Closeable;
import java.io.IOException;

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

public interface RecordWriter extends Closeable {
    /**
     * Writes the given record to the underlying stream
     *
     * @param record the record to write
     * @return the results of writing the data
     * @throws IOException if unable to write to the underlying stream
     */
    WriteResult write(Record record) throws IOException;

    /**
     * @return the MIME Type that the Record Writer produces. This will be added to FlowFiles using
     *         the mime.type attribute.
     */
    String getMimeType();

    /**
     * Flushes any buffered data to the underlying stream
     *
     * @throws IOException if unable to write to the underlying stream
     */
    void flush() throws IOException;
}