Merge pull request #791 from stefanbirkner/member-improvement

Improve FrameworkMember, FrameworkMethod and FrameworkField

Author: kcooney

src/main/java/org/junit/runners/model/FrameworkField.java

@@ -2,7 +2,6 @@
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Field;
-import java.lang.reflect.Modifier;
 
 import org.junit.runners.BlockJUnit4ClassRunner;
 
@@ -16,6 +15,10 @@ public class FrameworkField extends FrameworkMember<FrameworkField> {
     private final Field fField;
 
     FrameworkField(Field field) {
+        if (field == null) {
+            throw new NullPointerException(
+                    "FrameworkField cannot be created without an underlying field.");
+        }
         fField = field;
     }
 
@@ -29,21 +32,14 @@ public Annotation[] getAnnotations() {
         return fField.getAnnotations();
     }
 
-    @Override
-    public boolean isPublic() {
-        int modifiers = fField.getModifiers();
-        return Modifier.isPublic(modifiers);
-    }
-
     @Override
     public boolean isShadowedBy(FrameworkField otherMember) {
         return otherMember.getName().equals(getName());
     }
 
     @Override
-    public boolean isStatic() {
-        int modifiers = fField.getModifiers();
-        return Modifier.isStatic(modifiers);
+    protected int getModifiers() {
+        return fField.getModifiers();
     }
 
     /**
@@ -73,4 +69,9 @@ public Class<?> getDeclaringClass() {
     public Object get(Object target) throws IllegalArgumentException, IllegalAccessException {
         return fField.get(target);
     }
+
+    @Override
+    public String toString() {
+        return fField.toString();
+    }
 }

src/main/java/org/junit/runners/model/FrameworkMember.java

@@ -1,6 +1,7 @@
 package org.junit.runners.model;
 
 import java.lang.annotation.Annotation;
+import java.lang.reflect.Modifier;
 import java.util.List;
 
 /**
@@ -25,9 +26,21 @@ boolean isShadowedBy(List<T> members) {
         return false;
     }
 
-    public abstract boolean isPublic();
+    protected abstract int getModifiers();
 
-    public abstract boolean isStatic();
+    /**
+     * Returns true if this member is static, false if not.
+     */
+    public boolean isStatic() {
+        return Modifier.isStatic(getModifiers());
+    }
+
+    /**
+     * Returns true if this member is public, false if not.
+     */
+    public boolean isPublic() {
+        return Modifier.isPublic(getModifiers());
+    }
 
     public abstract String getName();
 

src/main/java/org/junit/runners/model/FrameworkMethod.java

@@ -19,12 +19,16 @@
  * @since 4.5
  */
 public class FrameworkMethod extends FrameworkMember<FrameworkMethod> {
-    final Method fMethod;
+    private final Method fMethod;
 
     /**
      * Returns a new {@code FrameworkMethod} for {@code method}
      */
     public FrameworkMethod(Method method) {
+        if (method == null) {
+            throw new NullPointerException(
+                    "FrameworkMethod cannot be created without an underlying method.");
+        }
         fMethod = method;
     }
 
@@ -99,22 +103,11 @@ public void validatePublicVoid(boolean isStatic, List<Throwable> errors) {
         }
     }
 
-    /**
-     * Returns true if this method is static, false if not
-     */
     @Override
-    public boolean isStatic() {
-        return Modifier.isStatic(fMethod.getModifiers());
+    protected int getModifiers() {
+        return fMethod.getModifiers();
     }
 
-    /**
-     * Returns true if this method is public, false if not
-     */
-    @Override
-    public boolean isPublic() {
-        return Modifier.isPublic(fMethod.getModifiers());
-    }
-    
     /**
      * Returns the return type of the method
      */
@@ -209,4 +202,9 @@ public <T extends Annotation> T getAnnotation(Class<T> annotationType) {
     public List<ParameterSignature> getParameterSignatures() {
         return ParameterSignature.signatures(fMethod);
     }
+
+    @Override
+    public String toString() {
+        return fMethod.toString();
+    }
 }

src/test/java/org/junit/runners/model/FrameworkFieldTest.java

@@ -0,0 +1,34 @@
+package org.junit.runners.model;
+
+import static org.junit.Assert.assertTrue;
+import static org.junit.rules.ExpectedException.none;
+
+import java.lang.reflect.Field;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+public class FrameworkFieldTest {
+    @Rule
+    public final ExpectedException thrown = none();
+
+    @Test
+    public void cannotBeCreatedWithoutUnderlyingField() {
+        thrown.expect(NullPointerException.class);
+        thrown.expectMessage("FrameworkField cannot be created without an underlying field.");
+        new FrameworkField(null);
+    }
+
+    @Test
+    public void hasToStringWhichPrintsFieldName() throws Exception {
+        Field field = ClassWithDummyField.class.getField("dummyField");
+        FrameworkField frameworkField = new FrameworkField(field);
+        assertTrue(frameworkField.toString().contains("dummyField"));
+    }
+
+    private static class ClassWithDummyField {
+        @SuppressWarnings("unused")
+        public final int dummyField = 0;
+    }
+}

src/test/java/org/junit/runners/model/FrameworkMethodTest.java

@@ -0,0 +1,35 @@
+package org.junit.runners.model;
+
+import static org.junit.Assert.assertTrue;
+import static org.junit.rules.ExpectedException.none;
+
+import java.lang.reflect.Method;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+public class FrameworkMethodTest {
+    @Rule
+    public final ExpectedException thrown = none();
+
+    @Test
+    public void cannotBeCreatedWithoutUnderlyingField() {
+        thrown.expect(NullPointerException.class);
+        thrown.expectMessage("FrameworkMethod cannot be created without an underlying method.");
+        new FrameworkMethod(null);
+    }
+
+    @Test
+    public void hasToStringWhichPrintsMethodName() throws Exception {
+        Method method = ClassWithDummyMethod.class.getMethod("dummyMethod");
+        FrameworkMethod frameworkMethod = new FrameworkMethod(method);
+        assertTrue(frameworkMethod.toString().contains("dummyMethod"));
+    }
+
+    private static class ClassWithDummyMethod {
+        @SuppressWarnings("unused")
+        public void dummyMethod() {
+        }
+    }
+}

src/test/java/org/junit/tests/AllTests.java

@@ -15,6 +15,8 @@
 import org.junit.runner.notification.SynchronizedRunListenerTest;
 import org.junit.runners.Suite;
 import org.junit.runners.Suite.SuiteClasses;
+import org.junit.runners.model.FrameworkFieldTest;
+import org.junit.runners.model.FrameworkMethodTest;
 import org.junit.tests.assertion.AssertionTest;
 import org.junit.tests.assertion.ComparisonFailureTest;
 import org.junit.tests.assertion.MultipleFailureExceptionTest;
@@ -196,6 +198,8 @@
         JUnitCommandLineParseResultTest.class,
         FilterFactoriesTest.class,
         CategoryFilterFactoryTest.class,
+        FrameworkFieldTest.class,
+        FrameworkMethodTest.class,
         JUnitCoreTest.class
 })
 public class AllTests {