org.simpleflatmapper.map.EnumerableMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sfm-map Show documentation

Java library to map flat record - ResultSet, csv - to java object with minimum configuration and low footprint.

There is a newer version: 9.0.2

package org.simpleflatmapper.map;

import org.simpleflatmapper.util.CheckedConsumer;
import org.simpleflatmapper.util.Enumerable;

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

/**
 *
 * @param  Enumerable Source type
 * @param  Target type
 * @param  Source exception type
 */
public interface EnumerableMapper {

    /**
     * Loop over the resultSet, map each row to a new newInstance of T and call back the handler
     *
     * The method will return the handler passed as an argument so you can easily chain the calls like 

     * 
     *     List<T> list = jdbcMapper.forEach(rs, new ListHandler<T>()).getList();
     * 
     * 

     *
     * @param source the source
     * @param handler the handler that will get the callback
     * @param  the row handler type
     * @return the handler passed in
     * @throws E if source error occurs
     * @throws MappingException if an error occurs during the mapping
     *
     */
    > H forEach(final SET source, final H handler)
            throws E, MappingException;
    /**
     *
     * @param source the source
     * @return an iterator that will return a map object for each row of the result set.
     * @throws E if source error occurs
     * @throws MappingException if an error occurs during the mapping
     */
    Iterator iterator(SET source)
            throws E, MappingException;
    
    /**
     *
     * @param source the source
     * @return a stream that will contain a map object for each row of the result set.
     * @throws E if source error occurs
     * @throws MappingException if an error occurs during the mapping
     */
    //IFJAVA8_START
    Stream stream(SET source) throws E, MappingException;
    //IFJAVA8_END

    Enumerable enumerate(SET source)
            throws E, MappingException;
    

}