org.simpleflatmapper.poi.SheetMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sfm-poi Show documentation
Excel POI supports.
The newest version!
package org.simpleflatmapper.poi;

import org.apache.poi.ss.usermodel.Sheet;
import org.simpleflatmapper.map.EnumerableMapper;
import org.simpleflatmapper.util.CheckedConsumer;
import org.simpleflatmapper.util.Enumerable;

import java.util.Iterator;
//IFJAVA8_START
import java.util.stream.Stream;
//IFJAVA8_END

public interface SheetMapper extends EnumerableMapper {

    /**
     *
     * @param sheet the sheet to map from
     * @return an iterator of mapped newInstance of T
     */
    @Override
    Iterator iterator(Sheet sheet);

    /**
     *
     * @param startRow row index to start at
     * @param sheet the sheet to map from
     * @return an iterator of mapped newInstance of T
     */
    Iterator iterator(int startRow, Sheet sheet);

    /**
     *
     * @param sheet the sheet to map from
     * @return an iterator of mapped newInstance of T
     */
    @Override
    Enumerable enumerate(Sheet sheet);

    /**
     *
     * @param startRow row index to start at
     * @param sheet the sheet to map from
     * @return an iterator of mapped newInstance of T
     */
    Enumerable enumerate(int startRow, Sheet sheet);
    
    /**
     *
     * @param sheet the sheet to map from
     * @param consumer the handler to call back
     * @param  the type of the handler
     * @return the handler
     */
    @Override
    > RH forEach(Sheet sheet, RH consumer);

    /**
     *
     * @param startRow row index to start at
     * @param sheet the sheet to map from
     * @param consumer the handler to call back
     * @param  the type of the handler
     * @return the handler
     */
    > RH forEach(int startRow, Sheet sheet, RH consumer);


    /**
     *
     * @param sheet the sheet to map from
     * @return a stream on mapped newInstance of T
     */
    //IFJAVA8_START
    @Override
    Stream stream(Sheet sheet);
    //IFJAVA8_END

    /**
     *
     * @param startRow row index to start at
     * @param sheet the sheet to map from
     * @return a stream on mapped newInstance of T
     */
    //IFJAVA8_START
    Stream stream(int startRow, Sheet sheet);
    //IFJAVA8_END
}