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;
026
027/**
028 * The base of a {@link ISchematic} file format
029 *
030 * @author Brady
031 * @since 12/23/2019
032 */
033public interface ISchematicFormat {
034
035    /**
036     * @return The parser for creating schematics of this format
037     */
038    IStaticSchematic parse(InputStream input) throws IOException;
039
040    /**
041     * @param file The file to check against
042     * @return Whether or not the specified file matches this schematic format
043     */
044    boolean isFileType(File file);
045}