mirror of
https://github.com/google/blockly.git
synced 2026-01-08 17:40:09 +01:00
e954193009
* fix: make exception constructors package * fix: rename blocks.load to blocks.append * fix: inline docs * fix: consistency in block serialization * fix: remove unexported functions * fix: interface requires * fix: tag TODO with issue number
72 lines
1.9 KiB
JavaScript
72 lines
1.9 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The record type for an object containing functions for
|
|
* serializing part of the workspace.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
goog.module('Blockly.serialization.ISerializer');
|
|
goog.module.declareLegacyNamespace();
|
|
|
|
// eslint-disable-next-line no-unused-vars
|
|
const Workspace = goog.requireType('Blockly.Workspace');
|
|
|
|
|
|
/**
|
|
* Serializes and deserializes a plugin or system.
|
|
* @interface
|
|
*/
|
|
class ISerializer {
|
|
constructor() {
|
|
/**
|
|
* A priority value used to determine the order of deserializing state.
|
|
* More positive priorities are deserialized before less positive
|
|
* priorities. Eg if you have priorities (0, -10, 10, 100) the order of
|
|
* deserialiation will be (100, 10, 0, -10).
|
|
* If two serializers have the same priority, they are deserialized in an
|
|
* arbitrary order relative to each other.
|
|
* @type {number}
|
|
*/
|
|
this.priority;
|
|
}
|
|
|
|
/* eslint-disable no-unused-vars, valid-jsdoc */
|
|
|
|
/**
|
|
* Saves the state of the plugin or system.
|
|
* @param {!Workspace} workspace The workspace the system to serialize is
|
|
* associated with.
|
|
* @return {?} A JS object containing the system's state, or null if
|
|
* there is no state to record.
|
|
*/
|
|
save(workspace) {}
|
|
|
|
/* eslint-enable valid-jsdoc */
|
|
|
|
/**
|
|
* Loads the state of the plugin or system.
|
|
* @param {?} state The state of the system to deserialize. This will always
|
|
* be non-null.
|
|
* @param {!Workspace} workspace The workspace the system to deserialize is
|
|
* associated with.
|
|
*/
|
|
load(state, workspace) {}
|
|
|
|
/**
|
|
* Clears the state of the plugin or system.
|
|
* @param {!Workspace} workspace The workspace the system to clear the state
|
|
* of is associated with.
|
|
*/
|
|
clear(workspace) {}
|
|
|
|
/* eslint-enable no-unused-vars */
|
|
}
|
|
|
|
exports.ISerializer = ISerializer;
|