Package org.kigalisim.lang.time

Class TimePointRealized

java.lang.Object
org.kigalisim.lang.time.TimePointRealized
public class TimePointRealized extends Object
Description of a time point.

Description of a time point. This may be specified as a specific timepoint like year 5 or year 2025. However, it may also be indicated using a "dynamic cap" which is a value like beginning or onwards which can be interpreted by context.

  • Constructor Details

    • TimePointRealized

      public TimePointRealized(EngineNumber pointValue)
      Create a new timepoint.
      Parameters:
      pointValue - The specific timepoint value.

    • TimePointRealized

      public TimePointRealized(String dynamicCap)
      Create a new timepoint.
      Parameters:
      dynamicCap - The dynamic cap value.

  • Method Details

    • isDynamicCap

      public boolean isDynamicCap()
      Determine if the user requested the dynamic cap value.
      Returns:
      True if the user requested a dynamic cap value like beginning.

    • getPointValue

      public EngineNumber getPointValue()
      Get the specific timepoint value.
      Returns:
      The specific timepoint value.
      Throws:
      IllegalStateException - If the timepoint is not a specific value (it is a dynamic cap).

    • getDynamicCap

      public String getDynamicCap()
      Get the dynamic cap value.
      Returns:
      The dynamic cap value.
      Throws:
      IllegalStateException - If the timepoint is not a dynamic cap (it is a specific value).