<?php

/**
 * Copyright (C) 2018-2022  CzechPMDevs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

declare(strict_types=1);

namespace czechpmdevs\buildertools\schematics\format;

use czechpmdevs\buildertools\blockstorage\BlockArray;
use czechpmdevs\buildertools\schematics\SchematicException;

interface Schematic {

	/**
	 * Function which should be used to load schematics and
	 * convert it to BlockArray.
	 *
	 * - It should be independent on main thread classes if used
	 *   on pmmp server
	 *
	 * @throws SchematicException
	 */
	public function load(string $rawData): BlockArray;

	/**
	 * Function which should be used to save schematics from
	 * BlockArray as string.
	 *
	 * - It should be independent on main thread classes if used
	 *   on pmmp server
	 *
	 * @throws SchematicException
	 */
	public function save(BlockArray $blockArray): string;

	/**
	 * Returns extension of the exported file (mostly
	 * '.schematic')
	 */
	public static function getFileExtension(): string;

	/**
	 * This function is used to validate format from raw data
	 * - Should not throw any errors neither exceptions
	 */
	public static function validate(string $rawData): bool;
}