001/*
002 * Copyright 2010-2015 Institut Pasteur.
003 * 
004 * This file is part of Icy.
005 * 
006 * Icy is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 * 
011 * Icy is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
014 * GNU General Public License for more details.
015 * 
016 * You should have received a copy of the GNU General Public License
017 * along with Icy. If not, see <http://www.gnu.org/licenses/>.
018 */
019package icy.sequence;
020
021import icy.file.SequenceFileExporter;
022
023/**
024 * Sequence exporter interface.<br>
025 * Used to define a specific exporter (appears in the <b>Export</b> section).<br>
026 * Note that you have the {@link SequenceFileExporter} interface* which allow to export
027 * {@link Sequence} to file.
028 * 
029 * @author Stephane
030 */
031public interface SequenceExporter
032{
033    /**
034     * Launch the exporter and save the specified Sequence.<br>
035     * The exporter is responsible to handle its own UI and save the wanted resource.
036     * 
037     * @param sequence
038     *        sequence to save
039     * @return <code>true</code> if the operation succeed
040     */
041    public boolean save(Sequence sequence);
042}