add state descriptions to javadoc

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
jetty · Jan 23, 2020 · 059bbfa · 059bbfa
1 parent f9f2cca
commit 059bbfa
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/MultiPartFormInputStream.java b/jetty-server/src/main/java/org/eclipse/jetty/server/MultiPartFormInputStream.java
@@ -60,6 +60,13 @@
  * is done by the parsing thread.
  * </p>
  * <pre>{@code
+ *
+ * UNPARSED - Parsing has not started, there are no parts which need to be cleaned up.
+ * PARSING  - The parsing thread is reading from the InputStream and generating parts.
+ * PARSED   - Parsing has complete and no more parts will be generated.
+ * ERROR    - deleteParts() has been called while we were in parsing state.
+ * DELETED  - The parts have been deleted, this is the terminal state.
+ *
  *                              deleteParts()
  *     +--------------------------------------------------------------+
  *     |                                                              |