Document that the output file is not deleted in case of error/cancel

PiperOrigin-RevId: 511189130
This commit is contained in:
kimvde 2023-02-21 14:57:24 +00:00 committed by Andrew Lewis
parent 7e377854a3
commit 948ccfe2a6

View file

@ -490,6 +490,8 @@ public final class Transformer {
/** /**
* Called if an exception occurs during the export. * Called if an exception occurs during the export.
* *
* <p>The export output file (if any) is not deleted in this case.
*
* @param composition The {@link Composition} for which the exception occurs. * @param composition The {@link Composition} for which the exception occurs.
* @param exportResult The {@link ExportResult} of the export. * @param exportResult The {@link ExportResult} of the export.
* @param exportException The {@link ExportException} describing the exception. This is the same * @param exportException The {@link ExportException} describing the exception. This is the same
@ -852,6 +854,8 @@ public final class Transformer {
/** /**
* Cancels the export that is currently in progress, if any. * Cancels the export that is currently in progress, if any.
* *
* <p>The export output file (if any) is not deleted.
*
* @throws IllegalStateException If this method is called from the wrong thread. * @throws IllegalStateException If this method is called from the wrong thread.
*/ */
public void cancel() { public void cancel() {