How to quickly determine if a method is overridden in Java

Question

There is a possible optimization I could apply to one of my methods, if I can determine that another method in the same class is not overridden. It is only a slight optimization, so reflection is out of the question. Should I just make a protected method that returns whether or not the method in question is overridden, such that a subclass can make it return true?

Answer 1

I wouldn't do this. It violates encapsulation and changes the contract of what your class is supposed to do without implementers knowing about it.

If you must do it, though, the best way is to invoke

class.getMethod("myMethod").getDeclaringClass();

If the class that's returned is your own, then it's not overridden; if it's something else, that subclass has overridden it. Yes, this is reflection, but it's still pretty cheap.

I do like your protected-method approach, though. That would look something like this:

public class ExpensiveStrategy {
  public void expensiveMethod() {
    // ...
    if (employOptimization()) {
      // take a shortcut
    }
  }

  protected boolean employOptimization() {
    return false;
  }
}

public class TargetedStrategy extends ExpensiveStrategy {
  @Override
  protected boolean employOptimization() {
    return true; // Now we can shortcut ExpensiveStrategy.
  }
}

Answer 2

Well, my optimization is a small yield on a case-by-case basis, and it only speeds things a lot because it is called hundreds of times per second.

You might want to see just what the Java optimizer can do. Your hand-coded optimization might not be necessary.

If you decide that hand-coded optimization is necessary, the protected method approach you described is not a good idea because it exposes the details of your implementation.

Answer 3

How many times do you expect the function to be called during the lifetime of the program? Reflection for a specific single method should not be too bad. If it is not worth that much time over the lifetime of the program my recommendation is to keep it simple, and don't include the small optimization.

Jacob

Answer 4

I know this is a slightly old question, but for the sake of other googlers:

I came up with a different solution using interfaces.

class FastSub extends Super {}
class SlowSub extends Super implements Super.LetMeHandleThis {
    void doSomethingSlow() {
        //not optimized
    }
}
class Super {
    static interface LetMeHandleThis {
        void doSomethingSlow();
    }
    void doSomething() {
        if (this instanceof LetMeHandleThis)
            ((LetMeHandleThis) this).doSomethingSlow();
        else
            doSomethingFast();
    }
    private final void doSomethingFast() {
        //optimized
    }
}

or the other way around:

class FastSub extends Super implements Super.OptimizeMe {}
class SlowSub extends Super {
    void doSomethingSlow() {
        //not optimized
    }
}
class Super {
    static interface OptimizeMe {}
    void doSomething() {
        if (this instanceof OptimizeMe)
            doSomethingFast();
        else
            doSomethingSlow();
    }
    private final void doSomethingFast() {
        //optimized
    }
    void doSomethingSlow(){}
}

Answer 5

private static boolean isMethodImplemented(Object obj, String name)
{
    try
    {
        Class<? extends Object> clazz = obj.getClass();

        return clazz.getMethod(name).getDeclaringClass().equals(clazz);
    }
    catch (SecurityException e)
    {
        log.error("{}", e);
    }
    catch (NoSuchMethodException e)
    {
        log.error("{}", e);
    }

    return false;
}

Answer 6

Annotate subclasses that overrides the particular method. @OverridesMethodX.

Perform the necessary reflective work on class load (i.e., in a static block) so that you publish the information via a final boolean flag. Then, query the flag where and when you need it.

Answer 7

maybe there is a cleaner way to do this via the Strategy Pattern, though I do not know how the rest of your application and data are modeled but it seem like it might fit.

It did to me anyhow when I was faced with a similar problem. You could have a heuristic that decides which strategy to use depending on the data that is to be processed.

Again, I do not have enough information on your specific usage to see if this is overkill or not. However I would refrain from changing the class signature for such specific optimization. Usually when I feel the urge to go against the current I take it as a sing that I had not forseen a corner case when I designed the thing and that I should refactor it to a cleaner more comprehensive solution.

however beware, such refactoring when done solely on optimization grounds almost inevitably lead to disaster. If this is the case I would take the reflecive approach suggested above. It does not alter the inheritance contract, and when done properly needs be done once only per subclass that requires it for the runtime life of the application.

Answer 8

Reflection can be used to determine if a method is overridden. The code is a little bit tricky. For instance, you need to be aware that you have a runtime class that is a subclass of the class that overrides the method.

You are going to see the same runtime classes over and over again. So you can save the results of the check in a WeakHashMap keyed on the Class.

See my code in java.awt.Component dealing with coalesceEvents for an example.

Answer 9

it might be another workaround which is similar to override another protected method returns true/false

I would suggest creating an empty interface, markup interface, then make the subclass implements this interface and inside the superclass check that this instance is instanceof this interface before calling the overridden expensive method.

Answer 10

This is a lambda's solution with synthetic introspection as in:

   private Component mComponent = new Component(this::overriddenMethod);
   protected void overriddenMethod() {}

---

Method:

void read(Runnable lambda) {
   try {
      Field f = lambda.getClass().getDeclaredFields()[0]; //No more indices
      f.setAccessible(true); //For some reason appears as "private final" so this is required.
      String canonName = f.get(lambda).getClass().getCanonicalName();
      //                  ^ I am not sure if this is a bit hyperbolic, please improve if possible, and report back!!
      System.out.println("class is = " + canonName);
   } catch (IllegalAccessException e) {
      throw new RuntimeException(e);
   }
}

Let's assume you have something like:

class EnclosingClass {
   private Component mComponent = new Component(this::overriddenMethod);
   protected void overriddenMethod() {}

   public static EnclosingClass giveMeOverridden(Runnable runnable) {
      return new EnclosingClass() {
         @Override
         protected void overriddenMethod() {
            runnable.run();
         }
     }
   }
}

---

class SubClass extends EnclosingClass {
   @Override
   protected void overriddenMethod() {
      //I've been overridden!!!
   }
}

---

public class Test {
   public static void main(String[] args) {
      EnclosingClass nonOveridden = new EnclosingClass();
      EnclosingClass overridden = new EnclosingClass() {
         @Override
         protected void overriddenMethod() {
            //I've been overridden!!!
         }
      }
      EnclosingClass factoryOverridden = EnclosingCLass.giveMeOverridden(
         () -> {
            //I've been overridden!!!
         }
      );
      SubClass subClass = new SubClass();
   }
}

---

class Component {
   Component(Runnable lambda) {
      read(lambda);
   }
}

---

Results:

class is = path.EnclosingClass //NON overridden!
class is = null // Overridden!!
class is = null // Overridden!!
class is = path.SubClass //not EnclosingClass?? Overridden!!!