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.List;
025import java.util.Optional;
026
027/**
028 * @author Brady
029 * @since 12/23/2019
030 */
031public interface ISchematicSystem {
032
033    /**
034     * @return The registry of supported schematic formats
035     */
036    Registry<ISchematicFormat> getRegistry();
037
038    /**
039     * Attempts to find an {@link ISchematicFormat} that supports the specified schematic file.
040     *
041     * @param file A schematic file
042     * @return The corresponding format for the file, {@link Optional#empty()} if no candidates were found.
043     */
044    Optional<ISchematicFormat> getByFile(File file);
045
046    /**
047     * @return A list of file extensions used by supported formats
048     */
049    List<String> getFileExtensions();
050}