de.larssh.utils

Class Completable

java.lang.Object

de.larssh.utils.Completable

Direct Known Subclasses:

AutoCompletable

public abstract class Completable
extends Object

Implementation of a boolean completed status, allowing objects to differentiate between an initialization phase and their final value. This implementation is synchronized.

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

Before using Completable think about using either a non-modifiable constructor or a builder class.

Constructor Summary

Constructors

Constructor and Description
Completable()

Method Summary

Modifier and Type	Method and Description
protected void	complete() Finishes the objects initialization phase.
boolean	isCompleted() Completed status
protected void	throwIfCompleted() In case the object has already been completed a CompletedException is thrown.

Methods inherited from class java.lang.Object

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

Constructor Detail

Completable

public Completable()

Method Detail

complete

protected void complete()

Finishes the objects initialization phase.

This method is recommended to be called by each getter.

throwIfCompleted

protected void throwIfCompleted()

In case the object has already been completed a CompletedException is thrown. Else nothing happens.

This method must be called by prior to object modification.

Throws:

CompletedException - if object is completed

isCompleted

public boolean isCompleted()

Completed status

Returns:

completed status