sirius.kernel.commons

Class Monoflop

java.lang.Object

sirius.kernel.commons.Monoflop

public class Monoflop
extends Object

Represents a boolean state variable, which can be toggled once from false to true.

All successive calls will not change the internal state, and return constantly true (or respectively).

This is particularly useful in loops where the first iteration must be handled differently. Therefore two more functions are provided: firstCall() and successiveCall() which can be used like shown here:

 
 Monoflop mono = Monoflop.create();
 StringBuilder sb = new StringBuilder();
 for(String value : somelist) {
     if (mono.successiveCall()) {
         sb.append(", ");
     }
     sb.append(value);
 }
 System.out.println(sb.toString());
 
 

Method Summary

Modifier and Type	Method and Description
static Monoflop	create() Creates a new monoflop.
boolean	firstCall() Reads and then toggles the monoflop.
boolean	inverseToggle() Toggles the monoflop and returns its state before it was toggled.
boolean	isToggled() Reads the internal state without toggling it.
boolean	successiveCall() Reads and then toggles the monoflop.
boolean	toggle() Toggles the monoflop and returns its state before it was toggled.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Monoflop create()

Creates a new monoflop.

Returns:

a new monoflop which was not toggled yet.

toggle

public boolean toggle()

Toggles the monoflop and returns its state before it was toggled.

If the monoflop is in its initial state, this will return false (and toggle the monoflop). Therefore all successive class will return true.

Returns:

false if the monoflop was not toggled yet, true for all successive calls

inverseToggle

public boolean inverseToggle()

Toggles the monoflop and returns its state before it was toggled.

If the monoflop is in its initial state, this will return true (and toggle the monoflop). Therefore all successive class will return false.

Returns:

true if the monoflop was not toggled yet, false for all successive calls

firstCall

public boolean firstCall()

Reads and then toggles the monoflop.

If the monoflop is in its initial state, this will return true (and toggle the monoflop). Therefore all successive class will return false.

This is just an alias for inverseToggle().

Returns:

true if the monoflop was not toggled yet, false for all successive calls

successiveCall

public boolean successiveCall()

Reads and then toggles the monoflop.

If the monoflop is in its initial state, this will return false (and toggle the monoflop). Therefore all successive class will return true.

This is just an alias for toggle().

Returns:

false if the monoflop was not toggled yet, true for all successive calls

isToggled

public boolean isToggled()

Reads the internal state without toggling it.

Returns:

false if the monoflop is in its initial state, true otherwise

toString

public String toString()

Overrides:

toString in class Object