org.jmrtd.cbeff.BiometricDataBlockDecoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jmrtd Show documentation

Java Machine Readable Travel Documents API.

There is a newer version: 0.7.42

/*
 * JMRTD - A Java API for accessing machine readable travel documents.
 *
 * Copyright (C) 2006 - 2013  The JMRTD team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * $Id: BiometricDataBlockDecoder.java 1552 2014-09-13 17:42:26Z martijno $
 */

package org.jmrtd.cbeff;

import java.io.IOException;
import java.io.InputStream;

/**
 * Interface to be implemented by client code to decode BDB implementations.
 * 
 * @author The JMRTD team ([email protected])
 * 
 * @version $Revision: 1552 $
 * 
 * @param  the type of BDB implementation that is decoded by this decoder
 * 
 * @since 0.4.7
 */
public interface BiometricDataBlockDecoder {

	/**
	 * Reads a biometric data block from an input stream.
	 * 
	 * @param inputStream the input stream to read from
	 * @param sbh the standard biometric header that preceded this BDB
	 * @param index the index of this BDB
	 * @param length the length of this BDB
	 * @return a biometric data block
	 * 
	 * @throws IOException if reading failed
	 */
	B decode(InputStream inputStream, StandardBiometricHeader sbh, int index, int length) throws IOException;
}