Merge pull request #8 from mariuszs/topic/cleanup

javadoc cleanup, removed duplicated code

Author: mariuszs

catch-exception/src/main/java/com/googlecode/catchexception/apis/BDDCatchException.java

@@ -24,7 +24,9 @@
  * approach to catch and verify exceptions (<i>given/when/then</i>).
  * <p>
  * EXAMPLE:
- * <code><pre class="prettyprint lang-java">// given an empty list
+ * <code><pre class="prettyprint lang-java">import static org.assertj.core.api.BDDAssertions.then;
+
+// given an empty list
 List myList = new ArrayList();
 
 // when we try to get the first element of the list
@@ -40,6 +42,9 @@
 thenThrown(IndexOutOfBoundsException.class);
 </pre></code>
  * <p>
+ * The Method {@link org.assertj.core.api.BDDAssertions#then(Throwable)} is originated from <a
+ * href="http://assertj.org">AssertJ</a>. You can also use method <code>assertThat</code>:
+ * <code><pre class="prettyprint lang-java">// import static org.assertj.core.api.Assertions.assertThat;
 
 // then we expect an IndexOutOfBoundsException
 assertThat(caughtException())
@@ -52,6 +57,7 @@
 </pre></code>
  * 
  * @author rwoo
+ * @author mariuszs
  * @since 1.3.0
  */
 public class BDDCatchException {

catch-exception/src/main/java/com/googlecode/catchexception/apis/CatchExceptionAssertJ.java

@@ -19,6 +19,41 @@
 import org.assertj.core.api.CompatibilityAssertions;
 
 /**
+ * Supports <a
+ * href="http://en.wikipedia.org/wiki/Behavior_Driven_Development">BDD</a>-like
+ * approach to catch and verify exceptions (<i>given/when/then</i>).
+ * <p>
+ * EXAMPLE:
+ * <code><pre class="prettyprint lang-java">// given an empty list
+ List myList = new ArrayList();
+
+ // when we try to get the first element of the list
+ when(myList).get(1);
+
+ // then we expect an IndexOutOfBoundsException
+ then(caughtException())
+ .isInstanceOf(IndexOutOfBoundsException.class)
+ .hasMessage("Index: 1, Size: 0")
+ .hasNoCause();
+
+ // then we expect an IndexOutOfBoundsException (alternatively)
+ thenThrown(IndexOutOfBoundsException.class);
+ </pre></code>
+ * <p>
+ * The Method {@link #then(Exception)} uses <a
+ * href="https://github.com/joel-costigliola/assertj-core">AssertJ</a>
+ * assertions. You can use them directly if you like:
+ * <code><pre class="prettyprint lang-java">// import static org.assertj.core.api.Assertions.assertThat;
+
+ // then we expect an IndexOutOfBoundsException
+ assertThat(caughtException())
+ .isInstanceOf(IndexOutOfBoundsException.class)
+ .hasMessage("Index: 1, Size: 0")
+ .hasMessageStartingWith("Index: 1")
+ .hasMessageEndingWith("Size: 0")
+ .hasMessageContaining("Size")
+ .hasNoCause();
+ </pre></code>
  *
  * @author rwoo
  * @since 1.1.0
@@ -53,8 +88,8 @@ public class CatchExceptionAssertJ extends BDDCatchException {
      * @param actualException
      *            the value to be the target of the assertions methods.
      * @return Returns the created assertion object.
-     * @see org.assertj.core.api.CompatibilityAssertions#assertThat(Throwable)
-     * @deprecated As of release 1.3.0, replaced by {@link org.assertj.core.api.BDDAssertions#then(java.lang.Throwable}
+     * @see org.assertj.core.api.Assertions#assertThat(Throwable)
+     * @deprecated As of release 1.3.0, replaced by {@link org.assertj.core.api.BDDAssertions#then(Throwable)}
      */
     public static AbstractThrowableAssert<?, ? extends Throwable> then(Exception actualException) {
         // delegate to AssertJ assertions

catch-exception/src/main/java/com/googlecode/catchexception/apis/CatchExceptionBdd.java

@@ -63,60 +63,7 @@
  * @deprecated As of release 1.3.0, replaced by {@link com.googlecode.catchexception.apis.BDDCatchException()}
  */
 @Deprecated
-public class CatchExceptionBdd {
-
-    /**
-     * Use it together with {@link #then(Exception)} or
-     * {@link #thenThrown(Class)} in order to catch an exception and to get
-     * access to the thrown exception (for further verifications).
-     * 
-     * @param <T>
-     *            The type of the given <code>obj</code>.
-     * 
-     * @param obj
-     *            The instance that shall be proxied. Must not be
-     *            <code>null</code>.
-     * @return Returns a proxy for the given object. The proxy catches
-     *         exceptions of the given type when a method on the proxy is
-     *         called.
-     * @see CatchException#catchException(Object)
-     */
-    public static <T> T when(T obj) {
-        return CatchException.catchException(obj);
-    }
-
-    /**
-     * Throws an assertion if no exception is thrown or if an exception of an
-     * unexpected type is thrown.
-     * <p>
-     * EXAMPLE:
-     * <code><pre class="prettyprint lang-java">// given a list with nine members
-List myList = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9);
-
-// when we try to get the 500th member of the fellowship
-when(myList).get(500);
-
-// then we expect an IndexOutOfBoundsException
-thenThrown(IndexOutOfBoundsException.class);
-</pre></code>
-     * 
-     * @param actualExceptionClazz
-     *            the expected type of the caught exception.
-     */
-    @SuppressWarnings({ "unchecked", "rawtypes" })
-    public static void thenThrown(Class actualExceptionClazz) {
-        Exception e = CatchException.caughtException();
-        if (e == null) {
-            // no exception caught -> assertion failed
-            throw new ExceptionNotThrownAssertionError(actualExceptionClazz);
-        } else if (!actualExceptionClazz.isAssignableFrom(CatchException
-                .caughtException().getClass())) {
-            // caught exception is of wrong type -> assertion failed
-            throw new ExceptionNotThrownAssertionError(actualExceptionClazz, e);
-        } else {
-            // the caught exception is of the expected type -> nothing to do :-)
-        }
-    }
+public class CatchExceptionBdd extends BDDCatchException {
 
     /**
      * Enables <a href="https://github.com/alexruiz/fest-assert-2.x">FEST Fluent

catch-throwable/src/main/java/com/googlecode/catchexception/throwable/apis/BDDCatchThrowable.java

@@ -22,7 +22,9 @@
  * Supports <a href="http://en.wikipedia.org/wiki/Behavior_Driven_Development">BDD</a>-like approach to catch and verify
  * throwables (<i>given/when/then</i>).
  * <p>
- * EXAMPLE: <code><pre class="prettyprint lang-java">// given an empty list
+ * <code><pre class="prettyprint lang-java">import static org.assertj.core.api.BDDAssertions.then;
+
+ // given an empty list
 List myList = new ArrayList();
 
 // when we try to get the first element of the list
@@ -37,6 +39,10 @@
 // then we expect an IndexOutOfBoundsThrowable (alternatively)
 thenThrown(IndexOutOfBoundsThrowable.class);
 </pre></code>
+ * <p>
+ * The Method {@link org.assertj.core.api.BDDAssertions#then(Throwable)} is originated from <a
+ * href="http://assertj.org">AssertJ</a>. You can also use method <code>assertThat</code>:
+ * <code><pre class="prettyprint lang-java">// import static org.assertj.core.api.Assertions.assertThat;
 
 // then we expect an IndexOutOfBoundsThrowable
 assertThat(caughtThrowable())
@@ -49,6 +55,7 @@
 </pre></code>
  * 
  * @author rwoo
+ * @author mariuszs
  * @since 1.3.0
  * 
  */

catch-throwable/src/main/java/com/googlecode/catchexception/throwable/apis/CatchThrowableAssertJ.java

@@ -19,12 +19,43 @@
 import org.assertj.core.api.CompatibilityAssertions;
 
 /**
- * Use BDDCatchThrowable
+ * Supports <a href="http://en.wikipedia.org/wiki/Behavior_Driven_Development">BDD</a>-like approach to catch and verify
+ * throwables (<i>given/when/then</i>).
+ * <p>
+ * EXAMPLE: <code><pre class="prettyprint lang-java">// given an empty list
+ List myList = new ArrayList();
+
+ // when we try to get the first element of the list
+ when(myList).get(1);
+
+ // then we expect an IndexOutOfBoundsThrowable
+ then(caughtThrowable())
+ .isInstanceOf(IndexOutOfBoundsThrowable.class)
+ .hasMessage("Index: 1, Size: 0")
+ .hasNoCause();
+
+ // then we expect an IndexOutOfBoundsThrowable (alternatively)
+ thenThrown(IndexOutOfBoundsThrowable.class);
+ </pre></code>
+ * <p>
+ * The Method {@link #then(Throwable)} uses <a href="https://github.com/joel-costigliola/assertj-core">AssertJ</a>
+ * assertions. You can use them directly if you like:
+ * <code><pre class="prettyprint lang-java">// import static org.assertj.core.api.Assertions.assertThat;
+
+ // then we expect an IndexOutOfBoundsThrowable
+ assertThat(caughtThrowable())
+ .isInstanceOf(IndexOutOfBoundsThrowable.class)
+ .hasMessage("Index: 1, Size: 0")
+ .hasMessageStartingWith("Index: 1")
+ .hasMessageEndingWith("Size: 0")
+ .hasMessageContaining("Size")
+ .hasNoCause();
+ </pre></code>
  *
  * @author rwoo
  * @since 1.2.0
  * @deprecated As of release 1.3.0, replaced by {@link com.googlecode.catchexception.throwable.apis.BDDCatchThrowable()}
- * @see com.googlecode.catchexception.throwable.apis.BDDCatchThrowable
+ * @see org.assertj.core.api.Assertions#assertThat(Throwable)
  */
 @Deprecated
 public class CatchThrowableAssertJ extends BDDCatchThrowable{

catch-throwable/src/main/java/com/googlecode/catchexception/throwable/apis/CatchThrowableBdd.java

@@ -62,57 +62,9 @@
  *
  */
 @Deprecated
-public class CatchThrowableBdd {
+public class CatchThrowableBdd extends BDDCatchThrowable {
 
-    /**
-     * Use it together with {@link #then(Throwable)} or {@link #thenThrown(Class)} in order to catch an throwable and to
-     * get access to the thrown throwable (for further verifications).
-     *
-     * @param <T>
-     *            The type of the given <code>obj</code>.
-     *
-     * @param obj
-     *            The instance that shall be proxied. Must not be <code>null</code>.
-     * @return Returns a proxy for the given object. The proxy catches throwables of the given type when a method on the
-     *         proxy is called.
-     * @see CatchThrowable#catchThrowable(Object)
-     */
-    public static <T> T when(T obj) {
-        return CatchThrowable.catchThrowable(obj);
-    }
-
-    /**
-     * Throws an assertion if no throwable is thrown or if an throwable of an unexpected type is thrown.
-     * <p>
-     * EXAMPLE:
-     * <code><pre class="prettyprint lang-java">// given a list with nine members
-     List myList = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9);
-
-     // when we try to get the 500th member of the fellowship
-     when(myList).get(500);
-
-     // then we expect an IndexOutOfBoundsThrowable
-     thenThrown(IndexOutOfBoundsThrowable.class);
-     </pre></code>
-     *
-     * @param actualThrowableClazz
-     *            the expected type of the caught throwable.
-     */
-    @SuppressWarnings({ "unchecked", "rawtypes" })
-    public static void thenThrown(Class actualThrowableClazz) {
-        Throwable e = CatchThrowable.caughtThrowable();
-        if (e == null) {
-            // no throwable caught -> assertion failed
-            throw new ThrowableNotThrownAssertionError(actualThrowableClazz);
-        } else if (!actualThrowableClazz.isAssignableFrom(CatchThrowable.caughtThrowable().getClass())) {
-            // caught throwable is of wrong type -> assertion failed
-            throw new ThrowableNotThrownAssertionError(actualThrowableClazz, e);
-        } else {
-            // the caught throwable is of the expected type -> nothing to do :-)
-        }
-    }
-
-    /**
+     /**
      * Enables <a href="https://github.com/alexruiz/fest-assert-2.x">FEST Fluent Assertions 2.x</a> about the caught
      * throwable.
      * <p>

functional-tests/catch-exception-assertj16/src/test/java/com/googlecode/catchexception/apis/BDDCatchExceptionAssertJ16Test.java

@@ -35,7 +35,7 @@
 *
 */
 @SuppressWarnings("javadoc")
-public class BDDCatchExceptionAssertJ16Test extends BDDCatchExceptionTest{
+public class BDDCatchExceptionAssertJ16Test extends BDDCatchExceptionTest {
 
     @SuppressWarnings("rawtypes")
     @Test