Package io.github.projectunified.cronutils.model

Class RebootCron

java.lang.Object
io.github.projectunified.cronutils.model.RebootCron
All Implemented Interfaces:
Cron, Serializable
public class RebootCron extends Object implements Cron
See Also:

  • Constructor Details

    • RebootCron

      public RebootCron(CronDefinition cronDefinition)
      Creates a Cron with the given cron definition and the given fields.
      Parameters:
      cronDefinition - the definition to use for this Cron

  • Method Details

    • retrieve

      public CronField retrieve(CronFieldName name)
      Retrieve value for cron field.
      Specified by:
      retrieve in interface Cron
      Parameters:
      name - - cron field name. If null, a NullPointerException will be raised.
      Returns:
      CronField that corresponds to given CronFieldName

    • retrieveFieldsAsMap

      public Map<CronFieldName,CronField> retrieveFieldsAsMap()
      Retrieve all cron field values as map.
      Specified by:
      retrieveFieldsAsMap in interface Cron
      Returns:
      unmodifiable Map with key CronFieldName and values CronField, never null

    • asString

      public String asString()
      Specified by:
      asString in interface Cron

    • getCronDefinition

      public CronDefinition getCronDefinition()
      Specified by:
      getCronDefinition in interface Cron

    • validate

      public Cron validate()
      Validates this Cron instance by validating its cron expression.
      Specified by:
      validate in interface Cron
      Returns:
      this Cron instance
      Throws:
      IllegalArgumentException - if the cron expression is invalid

    • equivalent

      public boolean equivalent(CronMapper cronMapper, Cron cron)
      Provides means to compare if two cron expressions are equivalent.
      Specified by:
      equivalent in interface Cron
      Parameters:
      cronMapper - - maps 'cron' parameter to this instance definition;
      cron - - any cron instance, never null
      Returns:
      boolean - true if equivalent; false otherwise.

    • equivalent

      public boolean equivalent(Cron cron)
      Provides means to compare if two cron expressions are equivalent. Assumes same cron definition.
      Specified by:
      equivalent in interface Cron
      Parameters:
      cron - - any cron instance, never null
      Returns:
      boolean - true if equivalent; false otherwise.

    • overlap

      public boolean overlap(Cron cron)
      Description copied from interface: Cron
      Checks if this cron expression overlaps with another cron expression.
      Specified by:
      overlap in interface Cron
      Parameters:
      cron - - The other cron expression to compare with, never null.
      Returns:
      true if the cron expressions overlap, false otherwise.