Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Using superclass "protected final" methods to keep common code for subclasses

As a (pedantic) beginner Java programmer I would like to know, is it a good practice to move a common block of code that all subclasses use to a separate protected (final) method in parent class? Tasks like filling lists with common values, or common filtering algorithms, etc... Is it good to also use protected static methods?

class A {
    protected final List<String> getVariants() {...}
    protected final List<String> filterResults(List<String> variants) {...}
}

class B extends A {
    public List<String> doSomethingUsefull() {
        List<String> commonVariants = getVariants();
        ...
        return filterResults(commonVariants);
    }
}

class C extends A {
    public void doSomethingUsefull() {
        List<String> commonVariants = getVariants();
        ...
        return filterResults(commonVariants);
    }

    public void doMoreUsefullThings() {
        List<String> commonVariants = getVariants();
        ...
        return filterResults(commonVariants);
    }
}
like image 998
dmzkrsk Avatar asked Oct 04 '11 17:10

dmzkrsk


3 Answers

If you're a Java beginner, or you are thinking about these sorts of things, then now is a good time to read the "Classes and Interfaces" chapter in a book called "Effective Java." The information there will be more thorough and nuanced than answers that you get here.

Here's one way to think about mixing the final, protected, and static keywords:

  • OO purists will advise you to avoid static because it breaks the OO paradigm.
  • Of course, using the final keyword prevents subclasses from overriding a method as well. In this respect, the outcome is the same as with static.
  • final should be used more often, and it's a good idea to use it along with protected. See Item 17 in "Effective Java".
  • protected and static are not used together very often. You'd be mixing an OO construct with a construct that breaks normal OO behavior, so the combination is odd.
like image 159
jtoberon Avatar answered Sep 25 '22 20:09

jtoberon


It seems reasonable to me - although you might want to make A abstract as well. Also consider using composition instead - could B and C contain an A instead of subclassing it?

like image 31
Jon Skeet Avatar answered Sep 26 '22 20:09

Jon Skeet


Firstly, you shouldn't use extends to this purpose because too much extending are always bad idea.

Secondly, You're completely right that you don't repeat your code, but grouping it by repeated part of code isn't good choice. Preferable way is to grouping things be meaning in real world, by level of abstraction.

Last but not least, When you have doubts: separately or not, extending or composition, protected final or only protected, try write unit test to this class and answers will come very fast.

like image 31
lukastymo Avatar answered Sep 22 '22 20:09

lukastymo