Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

why to avoid constant folding in Java? When?

I saw some codes in slf4j as show below. I don't know why to avoid constant folding in here. Is it necessary to do that? or just best practice. what's the benefit of doing this?

Thanks.

/**
  * Declare the version of the SLF4J API this implementation is compiled against. 
  * The value of this field is usually modified with each release. 
  */
// to avoid constant folding by the compiler, this field must *not* be final
public static String REQUESTED_API_VERSION = "1.6";  // !final**
like image 529
easycoder Avatar asked Jan 15 '11 18:01

easycoder


1 Answers

In the particular case where you are releasing a library, you often don't have control of the final version of the logging library that is eventually linked in at the end. For example you are using version 1.6, and the application that is using your library might use 1.6.1 to get a bugfix. Since it's only a point release the API should be compatible, but if your library inspects the SLF4J version it should show 1.6.1 not 1.6.

If the constant is inlined you will see 1.6 (since it's copied into your class file) even if the library is upgraded after the fact.

like image 167
Steven Schlansker Avatar answered Oct 26 '22 09:10

Steven Schlansker