/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You 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.apache.poi.hssf.eventusermodel.dummyrecord;


import java.util.Map;
import java.util.function.Supplier;

import org.apache.poi.hssf.record.HSSFRecordTypes;
import org.apache.poi.util.GenericRecordUtil;

/**
 * A dummy record for when we're missing a row, but still
 *  want to trigger something
 */
public final class MissingRowDummyRecord extends DummyRecordBase {
	private final int rowNumber;

	public MissingRowDummyRecord(int rowNumber) {
		this.rowNumber = rowNumber;
	}
	public int getRowNumber() {
		return rowNumber;
	}

	@Override
	public MissingRowDummyRecord copy() {
		return this;
	}

	@Override
	public HSSFRecordTypes getGenericRecordType() {
		return null;
	}

	@Override
	public Map<String, Supplier<?>> getGenericProperties() {
		return GenericRecordUtil.getGenericProperties(
			"rowNumber", this::getRowNumber
		);
	}
}