org.apache.poi.xssf.streaming.RowGeneratorFunction Maven / Gradle / Ivy

Go to download
/* ====================================================================
   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.poi.xssf.streaming;

import org.apache.poi.util.Beta;

/**
 * RowGeneratorFunction for Deferred SXSSF sheets
 *
 * @see DeferredSXSSFWorkbook
 */
@Beta
public interface RowGeneratorFunction {
    
    /**
     * Generate and add rows to the sheet. Note that anything that does not relate to creating rows and cells
     * should not be done inside this function. It is best to create cell styles and sheet level settings in
     * separate calls outside this function.
     *
     * @param sheet the sheet
     * @throws Exception the exception
     */
    void generateRows(SXSSFSheet sheet) throws Exception;
}