rename ignoreClasses to discardClasses (#240)

Author: richardelms

bugsnag/src/main/java/com/bugsnag/Bugsnag.java

@@ -243,10 +243,10 @@ public void setRedactedKeys(String... redactedKeys) {
     /**
      * Set which exception classes should be ignored (not sent) by Bugsnag.
      *
-     * @param ignoreClasses a list of exception classes to ignore
+     * @param discardClasses a list of exception classes to ignore
      */
-    public void setIgnoreClasses(String... ignoreClasses) {
-        config.ignoreClasses = ignoreClasses;
+    public void setDiscardClasses(String... discardClasses) {
+        config.discardClasses = discardClasses;
     }
 
     /**
@@ -440,7 +440,7 @@ public boolean notify(Report report, Callback reportCallback) {
 
         // Don't notify if this error class should be ignored
         if (config.shouldIgnoreClass(report.getExceptionName())) {
-            LOGGER.debug("Error not reported to Bugsnag - {} is in 'ignoreClasses'",
+            LOGGER.debug("Error not reported to Bugsnag - {} is in 'discardClasses'",
                     report.getExceptionName());
             return false;
         }

bugsnag/src/main/java/com/bugsnag/BugsnagAppender.java

@@ -52,7 +52,7 @@ public class BugsnagAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
     private Set<String> redactedKeys = new HashSet<String>();
 
     /** Exception classes to be ignored. */
-    private Set<String> ignoredClasses = new HashSet<String>();
+    private Set<String> discardClasses = new HashSet<String>();
 
     /** Release stages that should be notified. */
     private Set<String> enabledReleaseStages = new HashSet<String>();
@@ -258,7 +258,7 @@ private Bugsnag createBugsnag() {
             bugsnag.setRedactedKeys(redactedKeys.toArray(new String[0]));
         }
 
-        bugsnag.setIgnoreClasses(ignoredClasses.toArray(new String[0]));
+        bugsnag.setDiscardClasses(discardClasses.toArray(new String[0]));
 
         if (!enabledReleaseStages.isEmpty()) {
             bugsnag.setEnabledReleaseStages(enabledReleaseStages.toArray(new String[0]));
@@ -395,25 +395,30 @@ public void setRedactedKeys(String key) {
         }
     }
 
+    @Deprecated
+    public void setIgnoredClass(String ignoredClass) {
+        setDiscardClass(ignoredClass);
+    }
+
     /**
-     * @see Bugsnag#setIgnoreClasses(String...)
+     * @see Bugsnag#setDiscardClasses(String...)
      */
-    public void setIgnoredClass(String ignoredClass) {
-        this.ignoredClasses.add(ignoredClass);
+    public void setDiscardClass(String discardClass) {
+        this.discardClasses.add(discardClass);
 
         if (bugsnag != null) {
-            bugsnag.setIgnoreClasses(this.ignoredClasses.toArray(new String[0]));
+            bugsnag.setDiscardClasses(this.discardClasses.toArray(new String[0]));
         }
     }
 
     /**
-     * @see Bugsnag#setIgnoreClasses(String...)
+     * @see Bugsnag#setDiscardClasses(String...)
      */
-    public void setIgnoredClasses(String ignoredClasses) {
-        this.ignoredClasses.addAll(split(ignoredClasses));
+    public void setDiscardClasses(String discardClasses) {
+        this.discardClasses.addAll(split(discardClasses));
 
         if (bugsnag != null) {
-            bugsnag.setIgnoreClasses(this.ignoredClasses.toArray(new String[0]));
+            bugsnag.setDiscardClasses(this.discardClasses.toArray(new String[0]));
         }
     }
 

bugsnag/src/main/java/com/bugsnag/Configuration.java

@@ -38,7 +38,7 @@ public class Configuration {
     public EndpointConfiguration endpointConfiguration;
     public Delivery sessionDelivery;
     public String[] redactedKeys = new String[] {"password", "secret", "Authorization", "Cookie"};
-    public String[] ignoreClasses;
+    public String[] discardClasses;
     public Set<String> enabledReleaseStages = null;
     public String[] projectPackages;
     public String releaseStage;
@@ -74,11 +74,11 @@ boolean shouldNotifyForReleaseStage() {
     }
 
     boolean shouldIgnoreClass(String className) {
-        if (ignoreClasses == null) {
+        if (discardClasses == null) {
             return false;
         }
 
-        List<String> classes = Arrays.asList(ignoreClasses);
+        List<String> classes = Arrays.asList(discardClasses);
         return classes.contains(className);
     }
 

bugsnag/src/test/java/com/bugsnag/AppenderTest.java

@@ -149,10 +149,10 @@ public void testBugsnagConfig() {
         assertTrue(redactedKeys.contains("password"));
         assertTrue(redactedKeys.contains("credit_card_number"));
 
-        assertEquals(2, config.ignoreClasses.length);
-        ArrayList<String> ignoreClasses = new ArrayList<String>(Arrays.asList(config.ignoreClasses));
-        assertTrue(ignoreClasses.contains("com.example.Custom"));
-        assertTrue(ignoreClasses.contains("java.io.IOException"));
+        assertEquals(2, config.discardClasses.length);
+        ArrayList<String> discardClasses = new ArrayList<String>(Arrays.asList(config.discardClasses));
+        assertTrue(discardClasses.contains("com.example.Custom"));
+        assertTrue(discardClasses.contains("java.io.IOException"));
 
         assertEquals(2, config.enabledReleaseStages.size());
         assertTrue(config.enabledReleaseStages.contains("development"));

bugsnag/src/test/java/com/bugsnag/BugsnagTest.java

@@ -58,17 +58,17 @@ public void testIgnoreClasses() {
         bugsnag.setDelivery(BugsnagTestUtils.generateDelivery());
 
         // Ignore neither
-        bugsnag.setIgnoreClasses();
+        bugsnag.setDiscardClasses();
         assertTrue(bugsnag.notify(new RuntimeException()));
         assertTrue(bugsnag.notify(new TestException()));
 
         // Ignore just RuntimeException
-        bugsnag.setIgnoreClasses(RuntimeException.class.getName());
+        bugsnag.setDiscardClasses(RuntimeException.class.getName());
         assertFalse(bugsnag.notify(new RuntimeException()));
         assertTrue(bugsnag.notify(new TestException()));
 
         // Ignore both
-        bugsnag.setIgnoreClasses(RuntimeException.class.getName(), TestException.class.getName());
+        bugsnag.setDiscardClasses(RuntimeException.class.getName(), TestException.class.getName());
         assertFalse(bugsnag.notify(new RuntimeException()));
         assertFalse(bugsnag.notify(new TestException()));
     }

bugsnag/src/test/resources/logback.xml

@@ -10,8 +10,8 @@
         <redactedKey>password</redactedKey>
         <redactedKey>credit_card_number</redactedKey>
 
-        <ignoredClass>java.io.IOException</ignoredClass>
-        <ignoredClass>com.example.Custom</ignoredClass>
+        <discardClass>java.io.IOException</discardClass>
+        <discardClass>com.example.Custom</discardClass>
 
         <enabledReleaseStage>test</enabledReleaseStage>
         <enabledReleaseStage>development</enabledReleaseStage>

examples/logback/src/main/resources/logback.xml

@@ -20,8 +20,8 @@
         <!--<redactedKey>password</redactedKey>-->
         <!--<redactedKey>credit_card_number</redactedKey>-->
 
-        <!--<ignoredClass>java.io.IOException</ignoredClass>-->
-        <!--<ignoredClass>com.example.Custom</ignoredClass>-->
+        <!--<discardClass>java.io.IOException</discardClass>-->
+        <!--<discardClass>com.example.Custom</discardClass>-->
 
         <!--<enabledReleaseStage>production</enabledReleaseStage>-->
         <!--<enabledReleaseStage>development</enabledReleaseStage>-->

features/fixtures/logback/ignored_class_config.xml

@@ -7,7 +7,7 @@
         <releaseStage>production</releaseStage>
         <appVersion>1.0.0</appVersion>
 
-		<ignoredClass>java.lang.RuntimeException</ignoredClass>
+		<discardClass>java.lang.RuntimeException</discardClass>
 
 		<endpoint>http://localhost:9339/notify</endpoint>
 	</appender>

features/fixtures/scenarios/src/main/java/com/bugsnag/mazerunner/scenarios/IgnoredExceptionScenario.java

@@ -15,7 +15,7 @@ public IgnoredExceptionScenario(Bugsnag bugsnag) {
     @Override
     public void run() {
 
-        bugsnag.setIgnoreClasses("java.lang.RuntimeException");
+        bugsnag.setDiscardClasses("java.lang.RuntimeException");
 
         bugsnag.notify(new RuntimeException("Should never appear"));
     }