org.apache.flink.graph.utils.proxy

Class OptionalBoolean

java.lang.Object

org.apache.flink.graph.utils.proxy.OptionalBoolean

public class OptionalBoolean
extends Object

A multi-state boolean.

This class is used by GraphAlgorithm configuration options to set a default value which can be overwritten. The default value is also used when algorithm configurations are merged and conflict.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OptionalBoolean.State States for OptionalBoolean.

Constructor Summary

Constructors

Constructor and Description
OptionalBoolean(boolean valueIfUnset, boolean valueIfConflicting) An OptionalBoolean has three possible states: true, false, and "unset".

Method Summary

Modifier and Type	Method and Description
boolean	conflictsWith(OptionalBoolean other) The conflicting states are true with false and false with true.
boolean	get() Get the boolean state.
protected OptionalBoolean.State	getState() Get the actual state.
void	mergeWith(OptionalBoolean other) State transitions.
void	set(boolean value) Set the boolean state.
void	unset() Reset to the unset state.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalBoolean

public OptionalBoolean(boolean valueIfUnset,
                       boolean valueIfConflicting)

An OptionalBoolean has three possible states: true, false, and "unset". The value is set when merged with a value of true or false. The state returns to unset either explicitly or when true is merged with false.

Parameters:

valueIfUnset - the value to return when the object's state is unset

valueIfConflicting - the value to return when the object's state is conflicting

Method Detail

get

public boolean get()

Get the boolean state.

Returns:

boolean state

set

public void set(boolean value)

Set the boolean state.

Parameters:

value - boolean state

unset

public void unset()

Reset to the unset state.

getState

protected OptionalBoolean.State getState()

Get the actual state.

Returns:

actual state

conflictsWith

public boolean conflictsWith(OptionalBoolean other)

The conflicting states are true with false and false with true.

Parameters:

other - object to test with

Returns:

whether the objects conflict

mergeWith

public void mergeWith(OptionalBoolean other)

State transitions. - if the states are the same then no change - if either state is unset then change to the other state - if the states are conflicting then set to the conflicting state

Parameters:

other - object from which to merge state