de.larssh.utils

Class AutoCompletable

java.lang.Object

de.larssh.utils.Completable

de.larssh.utils.AutoCompletable

All Implemented Interfaces:

AutoCloseable

public abstract class AutoCompletable
extends Completable
implements AutoCloseable

This class implements a boolean completed status, allowing objects to differentiate between an initialization phase and their final value.

In addition to Completable it implements AutoCloseable to allow simplified factory methods using try-with-resource statement.

Each getter is recommended to call #complete(), while setters must call #throwIfCompleted() prior to modification.

Before using AutoCompletable think about using either a streamlined constructor or a builder class.

Example: SomeFancyThing is of type AutoCloseable. The method getSomeFancyThing() is meant to initialize SomeFancyThing while it should no longer be modifiable outside that method.

 SomeFancyThing getSomeFanyThing() {
        try (SomeFancyThing someFanyThing = new SomeFancyThing()) {
                ...
                return someFanyThing;
        }
 }
 

Constructor Summary

Constructors

Constructor and Description
AutoCompletable()

Method Summary

Modifier and Type	Method and Description
void	close() Calls Completable.complete() to finish the objects initialization phase.

Methods inherited from class de.larssh.utils.Completable

complete, isCompleted, throwIfCompleted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoCompletable

public AutoCompletable()

Method Detail

close

public void close()

Calls Completable.complete() to finish the objects initialization phase.

Specified by:

close in interface AutoCloseable