svn commit: r1447050 - /commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/BeanReflectionException.java

[br...@apache.org]

Author: britter
Date: Sun Feb 17 17:46:37 2013
New Revision: 1447050

URL: http://svn.apache.org/r1447050
Log:
Add JavaDoc for BeanReflectionException - no functional changes

Modified:
    commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/BeanReflectionException.java

Modified: commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/BeanReflectionException.java
URL: http://svn.apache.org/viewvc/commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/BeanReflectionException.java?rev=1447050&r1=1447049&r2=1447050&view=diff
==============================================================================
--- commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/BeanReflectionException.java (original)
+++ commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/BeanReflectionException.java Sun Feb 17 17:46:37 2013
@@ -21,6 +21,12 @@ package org.apache.commons.beanutils2;
 
 import static java.lang.String.format;
 
+/**
+ * <p>
+ * Base class for exceptions thrown by the library. Subclasses are used for wrapping the checked exceptions thrown by the
+ * {@code java.lang.refelct} and {@code java.lang.introspection} APIs.
+ * </p>
+ */
 public class BeanReflectionException
     extends RuntimeException
 {
@@ -29,12 +35,14 @@ public class BeanReflectionException
     private final Class<?> beanType;
 
     /**
-     * Constructs a new instance of BeanReflectionException.
+     * <p>
+     * Constructs a new instance of {@code BeanReflectionException}.
+     * </p>
      *
-     * @param cause the throwable that caused the exception
-     * @param beanType the bean type, the exception is associated with
-     * @param messagePattern the message pattern for the exception's message
-     * @param arguments the arguments referenced by the format specifiers in the message pattern
+     * @param cause the throwable that caused the exception.
+     * @param beanType the bean type, the exception is associated with.
+     * @param messagePattern the message pattern for the exception's message.
+     * @param arguments the arguments referenced by the format specifiers in the message pattern.
      */
     public BeanReflectionException( Throwable cause, Class<?> beanType, String messagePattern, Object... arguments )
     {
@@ -43,10 +51,12 @@ public class BeanReflectionException
     }
 
     /**
-     * Constructs a new instance of BeanReflectionException.
+     * <p>
+     * Constructs a new instance of {@code BeanReflectionException}.
+     * </p>
      *
-     * @param cause the throwable that caused the exception
-     * @param beanType the bean type, the exception is associated with
+     * @param cause the throwable that caused the exception.
+     * @param beanType the bean type, the exception is associated with.
      */
     public BeanReflectionException( Throwable cause, Class<?> beanType )
     {
@@ -54,6 +64,15 @@ public class BeanReflectionException
         this.beanType = beanType;
     }
 
+    /**
+     * <p>
+     * Returns the type that caused the exception. This may be the {@link Class} object that was the target of a static
+     * method or constructor invocation (via a {@link ClassAccessor}) or the {@link Class} of a bean that was the target
+     * of a method invocation or property access (via a {@link BeanAccessor}).
+     * </p>
+     *
+     * @return the type that caused the exception.
+     */
     public Class<?> getBeanType()
     {
         return beanType;