Deprecate sponge schematic reader/writer and tell users why (#1287)

Dieser Commit ist enthalten in:
dordsor21 2021-09-12 15:57:52 +01:00 committet von NotMyFault
Ursprung 8e214b1232
Commit 5d31b7034d
Es konnte kein GPG-Schlüssel zu dieser Signatur gefunden werden
GPG-Schlüssel-ID: 158F5701A6AAD00C
4 geänderte Dateien mit 19 neuen und 3 gelöschten Zeilen

Datei anzeigen

@ -177,7 +177,7 @@ public class FaweDelegateSchematicHandler {
public void run(OutputStream output) { public void run(OutputStream output) {
if (weTag instanceof CompressedSchematicTag) { if (weTag instanceof CompressedSchematicTag) {
Clipboard clipboard = ((CompressedSchematicTag) weTag).getSource(); Clipboard clipboard = ((CompressedSchematicTag) weTag).getSource();
BuiltInClipboardFormat.SPONGE_SCHEMATIC.write(output, clipboard); BuiltInClipboardFormat.FAST.write(output, clipboard);
} }
try { try {
try (ParallelGZIPOutputStream gzip = new ParallelGZIPOutputStream(output)) { try (ParallelGZIPOutputStream gzip = new ParallelGZIPOutputStream(output)) {

Datei anzeigen

@ -51,7 +51,7 @@ import java.util.zip.GZIPOutputStream;
public enum BuiltInClipboardFormat implements ClipboardFormat { public enum BuiltInClipboardFormat implements ClipboardFormat {
//FAWE start - register fast clipboard io //FAWE start - register fast clipboard io
FAST("fast", "fawe") { FAST("fast", "fawe", "sponge", "schem") {
@Override @Override
public String getPrimaryFileExtension() { public String getPrimaryFileExtension() {
return "schem"; return "schem";
@ -119,7 +119,13 @@ public enum BuiltInClipboardFormat implements ClipboardFormat {
} }
}, },
SPONGE_SCHEMATIC("sponge", "schem") { /**
* @deprecated Slow, resource intensive, but sometimes safer than using the recommended
* {@link BuiltInClipboardFormat#FAST}.
* Avoid using with any large schematics/clipboards for reading/writing.
*/
@Deprecated
SPONGE_SCHEMATIC("slow", "safe") {
@Override @Override
public String getPrimaryFileExtension() { public String getPrimaryFileExtension() {
return "schem"; return "schem";

Datei anzeigen

@ -68,7 +68,12 @@ import static com.google.common.base.Preconditions.checkNotNull;
/** /**
* Reads schematic files using the Sponge Schematic Specification. * Reads schematic files using the Sponge Schematic Specification.
*
* @deprecated Slow, resource intensive, but sometimes safer than using the recommended
* {@link com.fastasyncworldedit.core.extent.clipboard.io.FastSchematicReader}.
* Avoid reading large schematics with this reader.
*/ */
@Deprecated
public class SpongeSchematicReader extends NBTSchematicReader { public class SpongeSchematicReader extends NBTSchematicReader {
private static final Logger LOGGER = LogManagerCompat.getLogger(); private static final Logger LOGGER = LogManagerCompat.getLogger();

Datei anzeigen

@ -53,7 +53,12 @@ import static com.google.common.base.Preconditions.checkNotNull;
/** /**
* Writes schematic files using the Sponge schematic format. * Writes schematic files using the Sponge schematic format.
*
* @deprecated Slow, resource intensive, but sometimes safer than using the recommended
* {@link com.fastasyncworldedit.core.extent.clipboard.io.FastSchematicWriter}.
* Avoid using large clipboards to create schematics with this writer.
*/ */
@Deprecated
public class SpongeSchematicWriter implements ClipboardWriter { public class SpongeSchematicWriter implements ClipboardWriter {
private static final int CURRENT_VERSION = 2; private static final int CURRENT_VERSION = 2;