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

Go to download
/*
 * JMRTD - A Java API for accessing machine readable travel documents.
 *
 * Copyright (C) 2006 - 2017  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: BiometricDataBlockEncoder.java 1662 2017-03-20 19:13:03Z martijno $
 */

package org.jmrtd.cbeff;

import java.io.IOException;
import java.io.OutputStream;

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

  /**
   * Writes the biometric data block in bdb to the output stream.
   * 
   * @param bdb the biometric data block to write
   * @param out the output stream to write to
   * 
   * @throws IOException if writing fails
   */
  void encode(B bdb, OutputStream out) throws IOException;
}