diff --git a/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java b/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java index 4b489c5..5381784 100644 --- a/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java +++ b/core/src/main/java/edu/umd/cs/piccolo/util/PAffineTransformException.java @@ -9,26 +9,62 @@ private final PAffineTransform errantTransform; + /** + * Constructs an Exception that represents an error with the + * errantTransform. + * + * @param errantTransform transform that caused the error + */ public PAffineTransformException(final PAffineTransform errantTransform) { this.errantTransform = errantTransform; } + /** + * Constructs an Exception that represents an error with the + * errantTransform. + * + * @param message Text message provided by the programmer about the context + * of the error + * @param errantTransform transform that caused the error + */ public PAffineTransformException(final String message, final PAffineTransform errantTransform) { super(message); this.errantTransform = errantTransform; } + /** + * Constructs an Exception that wraps another and records the errant + * transform. + * + * @param throwable the root cause of the exception + * @param errantTransform transform that's related to the error + */ public PAffineTransformException(final Throwable throwable, final PAffineTransform errantTransform) { super(throwable); this.errantTransform = errantTransform; } + /** + * Constructs an Exception that wraps another and records the errant + * transform and provides a human readable message about the exception's + * context. + * + * @param message Text message provided by the programmer about the context + * of the error + * @param throwable the root cause of the exception + * @param errantTransform transform that's related to the error + */ public PAffineTransformException(final String message, final Throwable throwable, final PAffineTransform errantTransform) { super(message, throwable); this.errantTransform = errantTransform; } + /** + * Used to access the transform related to this exception. + * + * @return transform related to the exception + */ public PAffineTransform getErrantTransform() { return errantTransform; }