FormatedFileHistory.java

/*
 * Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 3 of the License, or (at your option)
 * any later version.
 * This program 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 General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see http://www.gnu.org/licenses/
 */
package org.esa.snap.ui;

import org.esa.snap.core.dataio.DecodeQualification;
import org.esa.snap.core.dataio.ProductReaderPlugIn;
import org.esa.snap.core.util.Guardian;

import java.io.File;

/**
 * <code>FileHistory</code> is a fixed-size array for the pathes of files opened/saved by a user. If a new file is added
 * and the file history is full, the list of registered files is shifted so that the oldest file path is beeing
 * skipped..
 *
 * @author Norman Fomferra
 * @version $Revision$  $Date$
 */
public class FormatedFileHistory extends FileHistory {

    private final ProductReaderPlugIn _productReaderPlugIn;

    public FormatedFileHistory(FileHistory history, ProductReaderPlugIn readerPlugIn) {
        this(history.getMaxNumEntries(), history.getPropertyKey(), readerPlugIn);
    }

    public FormatedFileHistory(int maxNumEntries, String propertyKey, ProductReaderPlugIn readerPlugIn) {
        super(maxNumEntries, propertyKey);
        Guardian.assertNotNull("readerPlugIn", readerPlugIn);
        _productReaderPlugIn = readerPlugIn;
    }

    @Override
    protected boolean isValidItem(String item) {
        if (super.isValidItem(item)) {
            final File file = new File(item);
            return _productReaderPlugIn.getDecodeQualification(file) != DecodeQualification.UNABLE;
        }
        return false;
    }
}