org.springframework.batch.item.excel.Sheet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-batch-excel Show documentation

Excel Iteam reader for spring batch

There is a newer version: 1.0.6

/*
 * Copyright 2006-2019 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
 *
 *      http://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.item.excel;

/**
 * Interface to wrap different Excel implementations like JExcel or Apache POI.
 * 
 * @author Marten Deinum
 * @since 0.5.0
 */
public interface Sheet {

    /**
     * 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.
     *
     * @param rowNumber the row number to read.
     * @return a {@code String[]} or {@code null}
     */
    String[] getRow(int rowNumber);

}