From d5fdc6a673b238c6ffb7c9ea9051dc03690e92ce Mon Sep 17 00:00:00 2001 From: Keith Donald Date: Tue, 14 Apr 2009 21:20:23 +0000 Subject: [PATCH] polish --- .../webflow/execution/FlowExecutionKeyFactory.java | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/spring-webflow/src/main/java/org/springframework/webflow/execution/FlowExecutionKeyFactory.java b/spring-webflow/src/main/java/org/springframework/webflow/execution/FlowExecutionKeyFactory.java index dde54ca7..615aa863 100644 --- a/spring-webflow/src/main/java/org/springframework/webflow/execution/FlowExecutionKeyFactory.java +++ b/spring-webflow/src/main/java/org/springframework/webflow/execution/FlowExecutionKeyFactory.java @@ -32,19 +32,22 @@ public interface FlowExecutionKeyFactory { public FlowExecutionKey getKey(FlowExecution execution); /** - * Update the snapshot indexed by key of the provided execution to capture the execution's current state. + * Capture the current state of the flow execution by updating its snapshot in storage. Does nothing if the no key + * has been assigned or no snapshot has already been taken. * @param execution the flow execution */ public void updateFlowExecutionSnapshot(FlowExecution execution); /** - * Remove the snapshot indexed by the key of the provided flow execution from storage. + * Remove the snapshot that was used to restore this flow execution, discarding it for future use. Does nothing if + * the no key been assigned or no snapshot has been taken. * @param execution the flow execution */ public void removeFlowExecutionSnapshot(FlowExecution execution); /** - * Remove all snapshots associated with the flow execution from storage. + * Remove all snapshots associated with the flow execution from storage, invalidating all history. Does nothing if + * no key has been assigned or no snapshots have been taken. * @param execution the flow execution */ public void removeAllFlowExecutionSnapshots(FlowExecution execution);