/*
 * Copyright 2006-2021 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.springframework.batch.extensions.excel;

import org.springframework.lang.Nullable;

/**
 * Interface to wrap different Excel implementations like JExcel or Apache POI.
 *
 * @author Marten Deinum
 * @since 0.1.0
 */
public interface Sheet extends Iterable<String[]>, AutoCloseable {

	/**
	 * Get the number of rows in this sheet.
	 * @return the number of rows.
	 */
	int getNumberOfRows();

	/**
	 * Get the name of the sheet.
	 * @return the name of the sheet.
	 */
	String getName();

	/**
	 * 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}
	 */
	@Nullable
	String[] getRow(int rowNumber);

	@Override
	default void close() throws Exception {
	}

}
