001/*
002 * This file is part of Baritone.
003 *
004 * Baritone is free software: you can redistribute it and/or modify
005 * it under the terms of the GNU Lesser General Public License as published by
006 * the Free Software Foundation, either version 3 of the License, or
007 * (at your option) any later version.
008 *
009 * Baritone is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012 * GNU Lesser General Public License for more details.
013 *
014 * You should have received a copy of the GNU Lesser General Public License
015 * along with Baritone.  If not, see <https://www.gnu.org/licenses/>.
016 */
017
018package baritone.api.schematic.format;
019
020import baritone.api.schematic.ISchematic;
021import baritone.api.schematic.IStaticSchematic;
022
023import java.io.File;
024import java.io.IOException;
025import java.io.InputStream;
026import java.util.List;
027
028/**
029 * The base of a {@link ISchematic} file format
030 *
031 * @author Brady
032 * @since 12/23/2019
033 */
034public interface ISchematicFormat {
035
036    /**
037     * @return The parser for creating schematics of this format
038     */
039    IStaticSchematic parse(InputStream input) throws IOException;
040
041    /**
042     * @param file The file to check against
043     * @return Whether or not the specified file matches this schematic format
044     */
045    boolean isFileType(File file);
046
047    /**
048     * @return A list of file extensions used by this format
049     */
050    List<String> getFileExtensions();
051}