tags:

views:

170

answers:

2

I just discovered local classes in Java:

public final class LocalClassTest
{
  public static void main(final String[] args) {
    for(int i = 10; i > 0; i--) {
      // Local class definition--declaring a new class local to the for-loop
      class DecrementingCounter {
        private int m_countFrom;

        public DecrementingCounter(final int p_countFrom) {
          m_countFrom = p_countFrom;
        }

        public void count() {
          for (int c = m_countFrom; c > 0; c--) {
            System.out.print(c + " ");
          }
          System.out.println();
        }
      }

      // Use the local class
      DecrementingCounter dc = new DecrementingCounter(i);
      dc.count();
    }
  }
}

I did come across this comment: Advantages of Local Classes which listed some great advantages of local classes over anonymous inner classes.

My question is, it doesn't seem like there would be many cases where this technique would have advantages over NON-anonymous inner classes. What I mean is: you would use a local class if your class is only useful inside a method's scope. But when your methods get to the point they are so complex you need to start defining custom classes inside of them, they are probably far too complex already, and need to be split up. At which point, your local class would have to become an inner class, right?

What are some examples of when local classes are more desirable than inner classes, which don't involved super-complex methods (which should be avoided)?

A: 

But, wouldn't that be the same as just doing this?

public static void main(String[] args) {
    for (int i = 10; i > 0; i--) {
        for (int c = i; c > 0; c--) {
            System.out.print(c + " ");
        }
        System.out.println();
    }
}

In your case, I just don't see how the local class will buy you anything, plus it is harder to read.

limc
It's possible he has to output a decreasing counter multiple times (i.e. enough times that, say, the number of lines in all the for loops is much larger than number of lines in defining the class). In this case, I'd argue it's actually easier to read.
Jan Gorzny
The example is contrived. I figured unless I posted some code many people would explain inner classes to me, instead of local classes.
Tom Tresansky
+1  A: 

Local class is something used in some particular method and nowhere else.

Let me provide an example, I used a local class in my JPEG decoder/encoder, when I read configurations from the file which will determine further decoding process. It looked like this:

class DecodeConfig {
    int compId;
    int dcTableId;
    int acTableId;
}

Basically it is just three ints grouped together. I needed an array of configurations, that's why I couldn't use just an anonymous class. If I had been coding in C, I would've used a structure.

I could do this with an inner class, but all the decoding process is handled in a single method and I don't need to use configurations anywhere else. That's why a local class would be sufficient.

This is, of course, the most basic example, but it's from the real life.

Malcolm
I'm sure you have your reasoning for this approach, but if you are solely shooting for C's structure-alike, wouldn't using Enum be a more proper solution?
limc
Enum won't do the trick, I read all the values from the file and they don't form a predefined set of values. Also I need to group three different parameters and I'm not sure how enums could help me do that.
Malcolm
Why did you choose to make this "struct" a local class instead of a private inner class? It was only used inside a single method? How complex would you say the method was?
Tom Tresansky
Exactly, it isn't used anywhere else. That's the main reason. The method is not complex (under 100 SLoC, by the way), but it has two parts. The first part is reading several configurations and storing them in an array. The second part is using these configurations to decode the following data. This process is done on a very high level, lower level code is hidden inside other classes. I don't need these configurations anymore once I'm done with decoding. Maybe I should edit my answer to explain why I'm using local class in this case, I've only illustrated how I use it (but that fact's implied).
Malcolm