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;
019
020import baritone.api.command.registry.Registry;
021import baritone.api.schematic.format.ISchematicFormat;
022
023import java.io.File;
024import java.util.Optional;
025
026/**
027 * @author Brady
028 * @since 12/23/2019
029 */
030public interface ISchematicSystem {
031
032    /**
033     * @return The registry of supported schematic formats
034     */
035    Registry<ISchematicFormat> getRegistry();
036
037    /**
038     * Attempts to find an {@link ISchematicFormat} that supports the specified schematic file.
039     *
040     * @param file A schematic file
041     * @return The corresponding format for the file, {@link Optional#empty()} if no candidates were found.
042     */
043    Optional<ISchematicFormat> getByFile(File file);
044}