Module com.flexganttfx.model
Package com.flexganttfx.model.activity

Class MutableChartActivityBase<T>

java.lang.Object
com.flexganttfx.model.activity.ActivityBase<T>
com.flexganttfx.model.activity.ChartActivityBase<T>
com.flexganttfx.model.activity.MutableChartActivityBase<T>
Type Parameters:
T - the type of the optional user object
All Implemented Interfaces:
Activity, ChartActivity, MutableActivity, MutableChartActivity
public class MutableChartActivityBase<T>
extends ChartActivityBase<T>
implements MutableChartActivity
The base implementation of a mutable chart activity.
Since:
1.0

  • Constructor Details

    • MutableChartActivityBase

      public MutableChartActivityBase()
      Constructs a new mutable chart activity. The initial start time will be set to Instant.now() and the end time will be equal to Instant.now() plus the value of ActivityBase.DEFAULT_DURATION. The chart value will be equal to zero.
      Since:
      1.0

    • MutableChartActivityBase

      public MutableChartActivityBase​(double value)
      Constructs a new mutable chart activity with the given value. The initial start time will be set to Instant.now() and the end time will be equal to Instant.now() plus the value of ActivityBase.DEFAULT_DURATION.
      Parameters:
      value - the chart value of the activity
      Since:
      1.0

    • MutableChartActivityBase

      public MutableChartActivityBase​(double value, Instant time)
      Constructs a new mutable chart activity with the given value. The start and end time will be equal to the given time.
      Parameters:
      value - the chart value of the activity
      time - the start and end time of the activity
      Since:
      1.0

    • MutableChartActivityBase

      public MutableChartActivityBase​(double value, Instant startTime, Instant endTime)
      Constructs a new mutable chart activity with the given value.
      Parameters:
      value - the chart value of the activity
      startTime - the start and end time of the activity
      endTime - the start and end time of the activity
      Since:
      1.5

  • Method Details

    • setName

      public void setName​(String name)
      Description copied from interface: MutableActivity
      Sets the name of the activity.
      Specified by:
      setName in interface MutableActivity
      Parameters:
      name - the new name of the activity

    • setUserObject

      public void setUserObject​(T userObject)
      Overrides:
      setUserObject in class ActivityBase<T>

    • setStartTime

      public void setStartTime​(Instant time)
      Description copied from interface: MutableActivity
      Sets a new start time on the activity.
      Specified by:
      setStartTime in interface MutableActivity
      Parameters:
      time - the new start time

    • setEndTime

      public void setEndTime​(Instant time)
      Description copied from interface: MutableActivity
      Sets a new end time on the activity.
      Specified by:
      setEndTime in interface MutableActivity
      Parameters:
      time - the new end time

    • setDuration

      public void setDuration​(Duration duration)
      Convenience method to determine a new end time based on a duration that will be added to the current start time of the activity.
      Parameters:
      duration - the duration of the activity
      Since:
      1.0

    • getDuration

      public Duration getDuration()
      Convenience method to determine the duration between the start and the end time of the activity.
      Returns:
      the duration of the activity

    • addDuration

      public void addDuration​(Duration duration)
      Convenience method to determine a new end time based on a duration that will be added once to the current end time of the activity.
      Parameters:
      duration - the duration of the activity
      Since:
      1.0

    • addDuration

      public void addDuration​(Duration duration, long multipliedBy)
      Convenience method to determine a new end time based on a duration that will be added several times to the current end time of the activity.
      Parameters:
      duration - the duration of the activity
      multipliedBy - the number of times that the duration will be added
      Since:
      1.0

    • setChartValue

      public void setChartValue​(double value)
      Description copied from interface: MutableChartActivity
      Sets a new chart value.
      Specified by:
      setChartValue in interface MutableChartActivity
      Parameters:
      value - the new value

    • toString

      public String toString()
      Overrides:
      toString in class ChartActivityBase<T>