Initialization-on-demand holder idiom

In software engineering, the initialization-on-demand holder (design pattern) idiom is a lazy-loaded singleton. In all versions of Java, the idiom enables a safe, highly concurrent lazy initialization of static fields with good performance. ^{[1] [2]}

publicclassSomething{privateSomething(){}privatestaticclassLazyHolder{staticfinalSomethingINSTANCE=newSomething();}publicstaticSomethinggetInstance(){returnLazyHolder.INSTANCE;}}

The implementation of the idiom relies on the initialization phase of execution within the Java Virtual Machine (JVM) as specified by the Java Language Specification (JLS). ^[3] When the class Something is loaded by the JVM, the class goes through initialization. Since the class does not have any static variables to initialize, the initialization completes trivially. The static class definition LazyHolder within it is not initialized until the JVM determines that LazyHolder must be executed. The static class LazyHolder is only executed when the static method getInstance is invoked on the class Something, and the first time this happens the JVM will load and initialize the LazyHolder class. The initialization of the LazyHolder class results in static variable INSTANCE being initialized by executing the (private) constructor for the outer class Something. Since the class initialization phase is guaranteed by the JLS to be sequential, i.e., non-concurrent, no further synchronization is required in the static getInstance method during loading and initialization. And since the initialization phase writes the static variable INSTANCE in a sequential operation, all subsequent concurrent invocations of the getInstance will return the same correctly initialized INSTANCE without incurring any additional synchronization overhead.

Caveats

While the implementation is an efficient thread-safe "singleton" cache without synchronization overhead, and better performing than uncontended synchronization, ^[4] the idiom can only be used when the construction of Something is guaranteed to not fail. In most JVM implementations, if construction of Something fails, subsequent attempts to initialize it from the same class-loader will result in a NoClassDefFoundError failure.

See also

• Singleton pattern
• Double-checked locking
• Multiton pattern

External links

• http://www.cs.umd.edu/~pugh/java/memoryModel/
• http://www.cs.umd.edu/~pugh/java/memoryModel/jsr-133-faq.html
• http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html

References

1. The double checked locking idiom does not work correctly in Java versions prior to 1.5.
2. INSTANCE should be package private
3. See 12.4 of Java Language Specification for details.
4. "Fastest Thread-safe Singleton in the JVM". literatejava.com.