You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2014/10/19 12:48:35 UTC
svn commit: r1632888 -
/pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/ValidationResult.java
Author: tilman
Date: Sun Oct 19 10:48:35 2014
New Revision: 1632888
URL: http://svn.apache.org/r1632888
Log:
PDFBOX-2403: Javadoc for the new members, as suggested by Ralf Hauser
Modified:
pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/ValidationResult.java
Modified: pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/ValidationResult.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/ValidationResult.java?rev=1632888&r1=1632887&r2=1632888&view=diff
==============================================================================
--- pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/ValidationResult.java (original)
+++ pdfbox/trunk/preflight/src/main/java/org/apache/pdfbox/preflight/ValidationResult.java Sun Oct 19 10:48:35 2014
@@ -188,15 +188,36 @@ public class ValidationResult
// TODO Add here COSObject or the PDObject that is linked to the error may a automatic fix can be done.
+ /**
+ * Always record the place in the source code where the ValidationError
+ * was created, in case the ValidationError was not caused by a
+ * Throwable.
+ */
private Throwable t = null;
+ /**
+ * Get the place where the ValidationError was created, useful if the
+ * ValidationError was not caused by a Throwable.
+ *
+ * @return The place where the ValidationError was created.
+ */
public Throwable getThrowable()
{
return t;
}
+ /**
+ * The underlying cause if the ValidationError was caused by a Throwable.
+ */
private Throwable cause = null;
+ /**
+ * Get the underlying cause if the ValidationError was caused by a
+ * Throwable.
+ *
+ * @return The underlying cause if the ValidationError was caused by a
+ * Throwable, or null if not.
+ */
public Throwable getCause()
{
return cause;
@@ -316,12 +337,11 @@ public class ValidationResult
}
/**
- * Create a validation error with the given error code and the error explanation.
- *
- * @param errorCode
- * the error code
- * @param details
- * the error explanation
+ * Create a validation error with the given error code and the error
+ * explanation.
+ *
+ * @param errorCode the error code
+ * @param details the error explanation
*/
public ValidationError(String errorCode, String details)
{