chore: deprecate FaweApi#load for clipboards as it does not allow closing (#2852)

This commit is contained in:
Jordan 2024-07-27 10:34:10 +02:00 committed by GitHub
parent 8c3df59413
commit dac7cdbe4b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -116,7 +116,10 @@ public class FaweAPI {
* @param file the file to load
* @return a clipboard containing the schematic
* @see ClipboardFormat
* @deprecated Opens streams that are not then closed. Use {@link ClipboardFormats#findByFile(File)} and its relevant
* methods to allow closing created streams/closing the reader (which will close the stream(s))
*/
@Deprecated(forRemoval = true, since = "TODO")
public static Clipboard load(File file) throws IOException {
return ClipboardFormats.findByFile(file).load(file);
}