com.alibaba.excel.read.listener

Interface ReadListener<T>

All Superinterfaces:

Listener

All Known Subinterfaces:

IgnoreExceptionReadListener<T>

All Known Implementing Classes:

AbstractIgnoreExceptionReadListener, AnalysisEventListener, ModelBuildEventListener, PageReadListener, SyncReadListener

public interface ReadListener<T>
extends Listener

Interface to listen for read results

Author:

Jiaju Zhuang

Method Summary

Modifier and Type	Method and Description
void	doAfterAllAnalysed(AnalysisContext context) if have something to do after all analysis
default void	extra(CellExtra extra, AnalysisContext context) The current method is called when extra information is returned
default boolean	hasNext(AnalysisContext context) Verify that there is another piece of data.You can stop the read by returning false
void	invoke(T data, AnalysisContext context) When analysis one row trigger invoke function.
default void	invokeHead(Map<Integer,ReadCellData<?>> headMap, AnalysisContext context) When analysis one head row trigger invoke function.
default void	onException(Exception exception, AnalysisContext context) All listeners receive this method when any one Listener does an error report.

Method Detail

onException

default void onException(Exception exception,
                         AnalysisContext context)
                  throws Exception

All listeners receive this method when any one Listener does an error report. If an exception is thrown here, the entire read will terminate.

Parameters:

exception -

context -

Throws:

Exception

invokeHead

default void invokeHead(Map<Integer,ReadCellData<?>> headMap,
                        AnalysisContext context)

When analysis one head row trigger invoke function.

Parameters:

headMap -

context -

invoke

void invoke(T data,
            AnalysisContext context)

When analysis one row trigger invoke function.

Parameters:

data - one row value. It is same as AnalysisContext.readRowHolder()

context - analysis context

extra

default void extra(CellExtra extra,
                   AnalysisContext context)

The current method is called when extra information is returned

Parameters:

extra - extra information

context - analysis context

doAfterAllAnalysed

void doAfterAllAnalysed(AnalysisContext context)

if have something to do after all analysis

Parameters:

context -

hasNext

default boolean hasNext(AnalysisContext context)

Verify that there is another piece of data.You can stop the read by returning false

Parameters:

context -

Returns: