fill in javadocs for the StreamsException class with new guarantees
Minor followup to / to write down the new guarantees we're providing about the meaning of a StreamsException in the javadocs of that class
Reviewers: Bruno Cadonna
@@ -22,7 +22,10 @@ import org.apache.kafka.streams.processor.TaskId;
import java.util.Optional;
/**
- * {@link StreamsException} is the top-level exception type generated by Kafka Streams.
+ * {@link StreamsException} is the top-level exception type generated by Kafka Streams, and indicates errors have
+ * occurred during a {@link org.apache.kafka.streams.processor.internals.StreamThread StreamThread's} processing. It
+ * is guaranteed that any exception thrown up to the {@link StreamsUncaughtExceptionHandler} will be of the type
+ * {@code StreamsException}. For example, any user exceptions will be wrapped as a {@code StreamsException}.
*/
public class StreamsException extends KafkaException {
