Интерфейс LazyConstant<T>

Ленивая константа создаётся с помощью фабричного метода LazyConstant.of(<computing function>).

После создания ленивая константа не инициализирована, то есть не содержит данных.

Затем ленивую константу (типа T) можно инициализировать (и получить её содержимое), вызвав get(). При первом вызове get() вызывается базовая вычисляющая функция (переданная при создании), а её результат используется для инициализации константы.

После инициализации ленивой константы её содержимое никогда не меняется и всегда возвращается при последующих вызовах get().

Рассмотрим следующий пример, в котором поле ленивой константы "logger" содержит объект типа Logger:

public class Component {

   // Creates a new uninitialized lazy constant
   private final LazyConstant<Logger> logger =
           LazyConstant.of( () -> Logger.create(Component.class) );

   public void process() {
       logger.get().info("Process started");
       // ...
   }
}

Изначально ленивая константа не инициализирована. При первом вызове logger.get() вычисляется функция инициализации, а константа инициализируется полученным результатом; затем результат возвращается вызывающему коду. Таким образом, get() гарантирует, что константа будет инициализирована до возврата из метода, если не возникнет исключение.

Кроме того, get() гарантирует, что из нескольких потоков, одновременно пытающихся вызвать вычисляющую функцию, для вычисления всегда будет выбран только один. Это свойство крайне важно, поскольку вычисление функции может иметь побочные эффекты. Например, приведённый выше вызов Logger.create() может привести к подготовке ресурсов хранилища.

Обработка исключений

Все сбои обрабатываются таким образом. Существуют два особых случая, в которых выбрасываются непроверяемые исключения:

Если вычисляющая функция возвращает null, будет выброшено исключение NoSuchElementException (причиной которого является NullPointerException). Поэтому ленивая константа никогда не может содержать значение null. Клиенты, которым нужна константа, допускающая значение null, могут обернуть значение в контейнер Optional.

Если вычисляющая функция рекурсивно вызывает саму себя через ленивую константу, будет выброшено исключение NoSuchElementException (причиной которого является IllegalStateException).

Композиция ленивых констант

public static class Foo {
     // ...
 }

public static class Bar {
    public Bar(Foo foo) {
         // ...
    }
}

static final LazyConstant<Foo> FOO = LazyConstant.of( Foo::new );
static final LazyConstant<Bar> BAR = LazyConstant.of( () -> new Bar(FOO.get()) );

public static Foo foo() {
    return FOO.get();
}

public static Bar bar() {
    return BAR.get();
}

Потокобезопасность

Вызов вычисляющей функции и последующая инициализация константы происходят до чтения содержимого инициализированной константы. Таким образом, содержимое инициализированной константы, включая любые поля final вновь созданных объектов, безопасно публикуется. Поскольку последующие обращения к содержимому могут быть устранены, повторный вызов get() не обеспечивает никаких иных гарантий упорядочивания операций с памятью или видимости.

Прерывание потока не отменяет инициализацию ленивой константы. Иными словами, если вычисляющий поток прерван, LazyConstant::get не сбрасывает статус прерывания потока и не выбрасывает InterruptedException.

Если вычисляющая функция блокируется на неопределённое время, другие потоки, работающие с этой ленивой константой, также могут блокироваться на неопределённое время; тайм-ауты и отмена не предусмотрены.

Производительность