From 3f81bdb75c5741dde746a76f1ec05969c72e4758 Mon Sep 17 00:00:00 2001 From: Marten Deinum Date: Tue, 26 Oct 2021 12:13:04 +0200 Subject: [PATCH] Polish --- .../springframework/batch/extensions/excel/Sheet.java | 4 +++- .../extensions/excel/streaming/StreamingSheet.java | 10 ++++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/Sheet.java b/spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/Sheet.java index 70080a2..5e7c9ee 100644 --- a/spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/Sheet.java +++ b/spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/Sheet.java @@ -39,7 +39,9 @@ public interface Sheet extends Iterable, AutoCloseable { String getName(); /** - * Get the row as a {@code String[]}. Returns {@code null} if the row doesn't exist. + * Get the row as a {@code String[]}. Returns {@code null} if the row doesn't exist. Can throw an {@code UnsupportedOperationException} + * when the underlying implementation doesn't support indexed access to rows. + * * @param rowNumber the row number to read. * @return a {@code String[]} or {@code null} */ diff --git a/spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/streaming/StreamingSheet.java b/spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/streaming/StreamingSheet.java index 0be89f9..24e355c 100644 --- a/spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/streaming/StreamingSheet.java +++ b/spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/streaming/StreamingSheet.java @@ -42,7 +42,13 @@ import org.springframework.batch.extensions.excel.Sheet; import org.springframework.util.StringUtils; import org.springframework.util.xml.StaxUtils; -class StreamingSheet implements Sheet, Iterable, Closeable { +/** + * {@code Sheet} implementation for Apache POI using the streaming event mode to read the rows. + * + * @author Marten Deinum + * @since 0.1.0 + */ +class StreamingSheet implements Sheet { private final Log logger = LogFactory.getLog(StreamingSheet.class); @@ -143,7 +149,7 @@ class StreamingSheet implements Sheet, Iterable, Closeable { } @Override - public void close() throws IOException { + public void close() throws Exception { try { this.reader.close(); }