Package org.opentcs.util

Class ExplainedBoolean

java.lang.Object
org.opentcs.util.ExplainedBoolean
public class ExplainedBoolean
extends java.lang.Object
A boolean with an explanation/reason for its value.

  • Constructor Summary

    Constructors 
    Constructor Description
    ExplainedBoolean​(boolean value, java.lang.String reason)
    Creates a new instance.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getReason()
    A reason/explanation for the value.
    boolean getValue()
    Returns the actual value.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ExplainedBoolean

      public ExplainedBoolean​(boolean value, @Nonnull java.lang.String reason)
      Creates a new instance.
      Parameters:
      value - The actual value.
      reason - A reason/explanation for the value.

  • Method Details

    • getValue

      public boolean getValue()
      Returns the actual value.
      Returns:
      The actual value.

    • getReason

      @Nonnull public java.lang.String getReason()
      A reason/explanation for the value.
      Returns:
      The reason