org.jmrtd.lds.AbstractListInfo 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 - 2018  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: AbstractListInfo.java 1765 2018-02-19 21:49:52Z martijno $
 */

package org.jmrtd.lds;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Abstract base class for several data structures used in the LDS
 * containing a list of elements.
 *
 * @author The JMRTD team ([email protected])
 *
 * @version $Revision: 1765 $
 *
 * @param  the type of the elements
 */
public abstract class AbstractListInfo extends AbstractLDSInfo {

  private static final long serialVersionUID = 2970076896364365191L;

  private static final Logger LOGGER = Logger.getLogger("org.jmrtd");

  private List subRecords;

  /**
   * Returns the sub-records of this list.
   *
   * @return the sub-records
   */
  protected List getSubRecords() {
    if (this.subRecords == null) {
      this.subRecords = new ArrayList();
    }

    return new ArrayList(this.subRecords);
  }

  /**
   * Adds a sub-record to this list.
   *
   * @param subRecord the sub-record to add
   */
  protected void add(R subRecord) {
    if (this.subRecords == null) {
      this.subRecords = new ArrayList();
    }
    this.subRecords.add(subRecord);
  }

  /**
   * Adds all sub-records in a collection.
   *
   * @param subRecords the sub-records to add
   */
  protected void addAll(List subRecords) {
    if (this.subRecords == null) {
      this.subRecords = new ArrayList();
    }
    this.subRecords.addAll(subRecords);
  }

  /**
   * Removes a sub-record at a given index.
   *
   * @param index the index of the sub-record to remove
   */
  protected void remove(int index) {
    if (this.subRecords == null) {
      this.subRecords = new ArrayList();
    }
    this.subRecords.remove(index);
  }

  @Override
  public boolean equals(Object other) {
    if (other == null) {
      return false;
    }
    if (other == this) {
      return true;
    }
    if (!(other instanceof AbstractListInfo)) {
      return false;
    }

    try {
      @SuppressWarnings("unchecked")
      AbstractListInfo otherRecord = (AbstractListInfo)other;
      List subRecords = getSubRecords();
      List otherSubRecords = otherRecord.getSubRecords();
      int subRecordCount = subRecords.size();
      if (subRecordCount != otherSubRecords.size()) {
        return false;
      }

      for (int i = 0; i < subRecordCount; i++) {
        R subRecord = subRecords.get(i);
        R otherSubRecord = otherSubRecords.get(i);
        if (subRecord == null) {
          if (otherSubRecord != null) {
            return false;
          }
        } else if (!subRecord.equals(otherSubRecord)) {
          return false;
        }
      }
      return true;
    } catch (ClassCastException cce) {
      LOGGER.log(Level.WARNING, "Wrong class", cce);
      return false;
    }
  }

  @Override
  public int hashCode() {
    int result = 1234567891;
    List subRecords = getSubRecords();
    for (R record: subRecords) {
      if (record == null) {
        result = 3 * result + 5;
      } else {
        result = 5 * (result + record.hashCode()) + 7;
      }
    }
    return 7 * result + 11;
  }

  /**
   * Writes this value to a stream.
   *
   * @param outputStream the stream to write to
   */
  @Override
  public abstract void writeObject(OutputStream outputStream) throws IOException;

  /**
   * Reads this value from a stream.
   *
   * @param inputStream the stream to read from
   *
   * @throws IOException on error reading from the stream
   */
  public abstract void readObject(InputStream inputStream) throws IOException;
}