[iceberg] branch master updated: Core: Clarify ValidationException Javadoc (#4258)

[sz...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

szehon pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iceberg.git


The following commit(s) were added to refs/heads/master by this push:
     new 7f07ed4  Core: Clarify ValidationException Javadoc (#4258)
7f07ed4 is described below

commit 7f07ed4515cbe86daefe07a367a755b65ad22740
Author: Lothar <10...@qq.com>
AuthorDate: Tue Mar 15 02:29:02 2022 +0800

    Core: Clarify ValidationException Javadoc (#4258)
---
 .../java/org/apache/iceberg/exceptions/ValidationException.java     | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/api/src/main/java/org/apache/iceberg/exceptions/ValidationException.java b/api/src/main/java/org/apache/iceberg/exceptions/ValidationException.java
index 7a78e43..a448947 100644
--- a/api/src/main/java/org/apache/iceberg/exceptions/ValidationException.java
+++ b/api/src/main/java/org/apache/iceberg/exceptions/ValidationException.java
@@ -24,7 +24,11 @@ import org.apache.iceberg.PartitionSpec;
 import org.apache.iceberg.Schema;
 
 /**
- * Exception raised when validation checks fail.
+ * Exception which is raised when the arguments are valid in isolation, but not in conjunction with
+ * other arguments or state, as opposed to {@link IllegalArgumentException} which is raised when
+ * an argument value is always invalid.
+ * <p>
+ * A ValidationException will cause the operation to abort.
  * <p>
  * For example, this is thrown when attempting to create a table with a {@link PartitionSpec} that
  * is not compatible with the table {@link Schema}