Commit 948ccfe2 by kimvde Committed by Andrew Lewis

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

PiperOrigin-RevId: 511189130
parent 7e377854
...@@ -490,6 +490,8 @@ public final class Transformer { ...@@ -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 { ...@@ -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() {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment